| Version 14 (modified by danvisel, 16 years ago) (diff) |
|---|
[[TicketQuery(summary=UNPLANNED_USER_DOC_SAMPLE, compact)]]
Analysis
This task is to present a sample of what the user documentation will look like.
Overview
Each numbered item in the documentation structure will have its own wiki page. The documentation text is from the Sophie 1.0 documentation, but it contains the same sort of documentation that will be used in the Sophie 2.0 releases.
Task requirements
- Documentation needs to be visible to end users.
- Documentation needs to be easily navigated (previous page/next page buttons; also a way to get back to the top of the documentation.)
- Needs to be possible to move pages of the documentation around if it's not going to be on Trac forever. (Where will this be?)
Task result
The result of this task is this page: UserDocumentationSample? which can be critiqued and revised until we know what we want the documentation to look like.
Implementation idea
A version of this can be looked at here: UserDocumentationSample?
Related
UNPLANNED_USER_DOC_STRUCTURE_R0 is the user documentation structure, which affects this directly.
How to demo
Look at UserDocumentationSample?, see if it works.
Design
Look at UserDocumentationSample?, see if it works.
Implementation
This can be done in the Trac wiki (does it stay in the Trac wiki?)
Testing
Comments
- How are we using images? inline? Is there a way to hide the attached file listing at the end of a wiki page?
- Standards/style guide can be found here: UNPLANNED_USER_DOC_STRUCTURE_StyleGuide?
- How granular should this be?
