ptc-catalog
End-user Documentation
Download this PTC (Markdown)Target
Create end-user documentation for a software project
User Story
As an application developer, I want to document our project, so that new users will try the application.
Card
| Stage | Description |
|---|---|
| 0 | Little or no project documentation exists. |
| 1 | An initial set of documentation has been created1,2. |
| 2 | Feedback from users is collected on a regular basis and is used to improve documentation3. |
| 3 | Scripts and/or auto-documentation tools are used to ensure the documentation is kept up to date. |
| 4 | Documentation maintenance is incorporated into the project’s continuous integration process. |
Comments
- A good method for staring is to investigate what documentation is provided by other contemporary similar projects. Inspired by research results, create a scope of your eventual ideal end-user documentation.
- Focus on creation of initial set of documentation that is most likely to be used by end-users (ex: README, software introduction guide, software installation and initial setup testing guide, troubleshooting guide etc.
- Develop a process to solicit feedback on the user documentation and incorporate improvements.
- Some documentation tools which could be useful:
Acknowledgement
This Project Tracking Card originated from the PSIP PTC Catalog. The development of the PSIP PTC Catalog was supported by the Exascale Computing Project (17-SC-20-SC), a collaborative effort of the U.S. Department of Energy Office of Science and the National Nuclear Security Administration.