Documentation Development: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 24: | Line 24: | ||
'''Edit''': With wiki software, a set of webpages can be made editable. | '''Edit''': With wiki software, a set of webpages can be made editable. | ||
=Examples= | |||
http://opensourceecology.org/wiki/Terminal_Case | |||
Revision as of 06:45, 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 make a separate copy of the information to use parts of the documentation for a separate project?
- How easily can the user edit the original or copied information to revise the documentation?
- How easily can edited information be made compatible with a different documentation system?
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.