User Tools

Site Tools


documentation:structure:software_guide

Software Guides

Purpose

These guides introduce a software package, what someone might use it for at the shop, here to get it, and where to find further resources: manuals, tutorials, etc.

It is not recommended we build comprehensive tutorials ourselves; these guides can cover specific quirks of the Protohaven environment, but the heavy lifting should be done by others.

Structure

The draft guidance for software section structure is as follows.

  • Software Name
    • Overview
    • Download
    • Help and Tutorials

Not every subsection will be required for every piece of software.

The Help and Tutorials section should point the student toward materials that will help them learn about the software: YouTube videos, starter guides, tutorials, etc.

Templates

Template files for creating new software sections are available in the Protohaven GitHub organization:

https://github.com/protohaven/printed_materials

…or through typst.app:

https://typst.app/project/wuQAU0imr2tgjgiydfRiPX

documentation/structure/software_guide.txt · Last modified: 2024/10/07 23:19 by paul