Documentation Standards
Jump to navigation
Jump to search
see Documentation Standards Old
Introduction
As the project moves towards viral replication, it is important to create effective documentation standards.
Design Rationale
The scope of effective documentation standards for OSE is:
- Understanding the standards makes it possible to navigate both graphically and via the address bar on the OSE wiki - to access any piece of documentation for any machine.
- Machine naming is standard. Currently, the names used on the main site at opensourceecology.org are used.
- Each machine has a Core and Supporting documentation set. The Core set includes those pieces of documentation that are indispensible for the safe and effective building and usage of GVCS tools by inexperienced builders/users. Supporting documentation is that which allows for the modification, remixing of modules, and other hacks on the machines. It also includes that information which makes replication easier, but which is not critical to such replication - by a novice builder.
- Each Machine has a finite, well-defined set of Core Documentation and Supporting Documentation.