In-Depth Guides
In support of the One Good Tutorial Checklist and the One Good Tutorial Playbook, we’ve prepared a number of in-depth guides that go into the details about how to prepare different standard elements of software documentation. They cover the following topics:
- Acknowledgment Statements
- Choosing an Authoring Tool
- Choosing a Publishing Tool
- Contact Information
- Citation Instructions and Software Citation
- Contribution Statements
- Installation Instructions
- Licensing Statements and Software Copyright
- Other Common Documentation Elements
- Personas
- Planning a Tutorial
- Writing a Project Synopsis
- Writing Reference Material
- Writing a Tutorial
