Wiki Guidelines

Documentation Guidelines

 * Any documents which are not relevant to current rover work should be moved to the archive

What and When to document, and who does it

 * Highlights of each individual's activity should be noted down by subgroup leads in meeting minutes for every meeting
 * This can be done at the end of a meeting or asynchronously after the meeting
 * Major milestones, major decisions, and important design documents should be compiled from minutes into documentation entries as per the documentation standards as soon as they are completed.

Major Page Formatting Standards
This section outlines a standard for each common type of page that will exist on this wiki. For consistency, readability, and navigability, most pages on the wiki should follow one of these standards. See special page standards for standards for less common page types. Every page should contain a reference to the standard it follows

Documentation Page Standard
Samples for Reference: Documentation Example

Documentation pages make up the majority of the Current Documentation as well as the Archive sections of the site, with the remainder of the documents in these sections being performance and design review reports.

The purpose of a documentation page is to convey the design process used during the development of a specific system on the rover. Each documentation page should cover only the development of one mechanism, and should go into sufficient detail that the overall design can be reproduced and understood. Navigability is crucial for the documentation pages, so the page naming and format conventions must be strictly followed, and any time content in another documentation page is mentioned, that page should be linked.

Documentation Site Structure
Documentation pages that pertain to specific rovers and systems within those rovers should fall into a simple hierarchy with four levels.:
 * Top Level: Rover Page - Each rover will have a single documentation page covering the overall design concept of that rover.
 * Contains links to all level 2 pages
 * Focus on what major issues were being addressed and what challenges were encountered in making these work.
 * Should provide technical information relevant to the rover as a whole and any interactions between subsystems.
 * Level 2: Subsystem Pages - Each rover should have a single documentation for each of the technical subsystems: Arm, Chassis, Electronics, Science, and Software.
 * Contains links back to relevant parts of the rover page, and to level 3 component pages.
 * Focus on the overall operating principle of the subsystem and its performance objectives and characteristics.
 * Should provide details of the interactions between components within the subsystem, and an overview of the design intent behind the subsystem.
 * Level 3: Component Pages
 * Focus on the

Other documentation pages, such as those for rover peripherals or test equipment, should follow this format but be organized separately. Research projects

Event Report Standard
Samples for Reference: Curriculum Example

Curriculum Page Standard
Samples for Reference: Curriculum Example

Knowledge Repository Page Standard
Samples for Reference: Knowledge Repository Example


 * Add a footnote at the