Difference between revisions of "Documentation/ReorganizeUserGuides"
Jaegerandi (talk | contribs) (→Additional Information) |
|||
| Line 2: | Line 2: | ||
Paired with the [https://wiki.openstack.org/wiki/User_Guides User Guide Specialty team page], this list of tasks to complete the project helps to keep track of changes to information architecture, consistency, and conventions in the guides. | Paired with the [https://wiki.openstack.org/wiki/User_Guides User Guide Specialty team page], this list of tasks to complete the project helps to keep track of changes to information architecture, consistency, and conventions in the guides. | ||
| + | |||
| + | Please add your name next to one of the tasks on the List of Tasks to prevent duplication of improvements detailed in the docs spec. | ||
== The List of Tasks == | == The List of Tasks == | ||
| Line 7: | Line 9: | ||
* Remove duplication in table of contents | * Remove duplication in table of contents | ||
** Several items repeat in the table of contents. Repairs to the RST files are needed. (This is done) | ** Several items repeat in the table of contents. Repairs to the RST files are needed. (This is done) | ||
| − | * Separate User Guides in separate directories while keeping a common directory to simplify setup and writing: | + | * Separate User Guides in separate directories while keeping a common directory to simplify setup and writing: (DONE) |
** https://review.openstack.org/#/q/status:open+topic:separate-user-guide,n,z | ** https://review.openstack.org/#/q/status:open+topic:separate-user-guide,n,z | ||
| + | * Develop the User Task Matrix | ||
| + | * Rework the abstract for each guide to clearly identify audience and purpose. | ||
| + | * Reduce duplication of content between the guides, pointing the Cloud Admin Guide to the Admin User Guide, and Admin User Guide to the End User Guide for readers to accomplish further tasks, which is a suitable step for the abstract rewrite. | ||
| + | * Remove any unnecessary or self-explanatory procedures from the dashboard chapter | ||
| + | * Determine a good structure for how to present tasks - Dashboard, Command-line, or Config File edits | ||
| + | |||
== Additional Information == | == Additional Information == | ||
Revision as of 05:24, 19 May 2015
Reorganise the User Guide - Task List
Paired with the User Guide Specialty team page, this list of tasks to complete the project helps to keep track of changes to information architecture, consistency, and conventions in the guides.
Please add your name next to one of the tasks on the List of Tasks to prevent duplication of improvements detailed in the docs spec.
The List of Tasks
- Remove duplication in table of contents
- Several items repeat in the table of contents. Repairs to the RST files are needed. (This is done)
- Separate User Guides in separate directories while keeping a common directory to simplify setup and writing: (DONE)
- Develop the User Task Matrix
- Rework the abstract for each guide to clearly identify audience and purpose.
- Reduce duplication of content between the guides, pointing the Cloud Admin Guide to the Admin User Guide, and Admin User Guide to the End User Guide for readers to accomplish further tasks, which is a suitable step for the abstract rewrite.
- Remove any unnecessary or self-explanatory procedures from the dashboard chapter
- Determine a good structure for how to present tasks - Dashboard, Command-line, or Config File edits
Additional Information
- Reorganize User Guides for Liberty Spec associated with the Reorganise User Guides Blueprint.
