Documentation Development: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 15: | Line 15: | ||
Webpages provide 2D visual information with audio. | Webpages provide 2D visual information with audio. | ||
'''Accessibility''': A web browser is the major requirement. | |||
'''Navigate''': A table of contents acts as an index. | |||
'''Copy''': Text and images can be copied. The webpage information can be downloaded as an html file. | |||
'''Edit''': With wiki software, a set of webpages can be made editable. | |||
Revision as of 05:39, 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.
Navigate: A table of contents acts as an index.
Copy: Text and images can be copied. The webpage information can be downloaded as an html file.
Edit: With wiki software, a set of webpages can be made editable.