PTC: Documentation

[frobnitzem]

End-user Documentation

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

0. • Little or no project documentation exists.
1. • An initial set of documentation has been created^1,2.
2. • Feedback from users is collected on a regular basis and is used to improve documentation³.
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

1. 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.
2. 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.
3. Develop a process to solicit feedback on the user documentation and incorporate improvements.
4. Some documentation tools which be useful:
   • Doxygen
   • Sphinx
   • ReadTheDocs
   • WriteTheDocs

[elaineraybourn]

I really like the idea of incorporating the numerical value (maybe difficulty points) for each goal (epic), a checklist of tasks, and associating user stories (issues) with the tasks. I would like to see a PTC card such as this one utilized in addition to the individual user story cards. We don't want to lose the ability to quickly see why teams are working toward their goals, and their progress toward completion at each stage (level) -- not to imply a rigid order.

[elaineraybourn]

@jarrah42 @frobnitzem @gonsie Note that I have created a new template based on the format above in the automation repo https://github.com/bssw-psip/psip-automation-development/projects/1#card-50509557. See what you think.

[frobnitzem]

closing this issue - since it has moved to psip-automation-development