Documentation Development: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
*How easily can the user edit the information to revise the documentation? | *How easily can the user edit the information to revise the documentation? | ||
*How easily can the user make a separate copy of the information to use parts of the documentation | *How easily can the user make a separate copy of the information to use parts of the documentation for a separate project? | ||
=Analysis= | |||
Webpages are currently the most accessible form of documentation. | |||
Webpages provide 2D visual information with audio. | |||
ACCESSIBILITY: A web browser is the major requirement. | |||
NAVIGABILITY: A table of contents acts as an index. | |||
EDITABILITY: With wiki software, a set of webpages can be made editable. | |||
COPYABILITY: Text and images can be copied. The webpage information can be downloaded as an html file. | |||
Revision as of 05:37, 17 September 2012
Open Source Documentation Objectives
- How accessible are the requirements to use the documentation? (ex. particular computer hardware and software)
- How easily can the user navigate the information to find what they want to know?
- How easily can the user edit the information to revise the documentation?
- How easily can the user make a separate copy of the information to use parts of the documentation for a separate project?
Analysis
Webpages are currently the most accessible form of documentation.
Webpages provide 2D visual information with audio.
ACCESSIBILITY: A web browser is the major requirement.
NAVIGABILITY: A table of contents acts as an index.
EDITABILITY: With wiki software, a set of webpages can be made editable.
COPYABILITY: Text and images can be copied. The webpage information can be downloaded as an html file.