Getting started as documentation person: Difference between revisions

Revision as of 18:54, 4 February 2015

Q: How do I document a GVCS Machine? Where do I find naming and formatting conventions?

A: This page helps you get started creating quality documentation for GVCS machines.

You should have read through the documents in Template:RequiredReading. Have a look at the current Civilization Starter Kit DVD and read through some of the documentation there.

How to Structure the Wiki for GVCS Machines proposes a concept to organize information inside this wiki using templates (currently implemented).
Documentation Standards proposes an alternative concept for wiki organization (partly implemented).

The Fabrication Diagram is a diagram that facilitates the build of a prototype. It contains a visual representation of all fabrication steps and parts.
Video
BoM
...

@@ Line 1: / Line 1: @@
-* [[How to Structure the Wiki for GVCS Machines]]
+== Overview ==
-* [[Documentation Standards]]
+'''Q: How do I document a [[GVCS Machine]]? Where do I find naming and formatting conventions?'''
+A: This page helps you get started creating quality documentation for GVCS machines.
+== Prequisites ==
+You should have read through the documents in [[Template:RequiredReading]]. Have a look at the current [[Civilization Starter Kit DVD]] and read through some of the documentation there.
+== Information structure ==
+* [[How to Structure the Wiki for GVCS Machines]] proposes a concept to organize information inside this wiki using templates (currently implemented).
+* [[Documentation Standards]] proposes an alternative concept for wiki organization (partly implemented).
+== Documentation types ==
+* The [[Fabrication Diagram]] is a diagram that facilitates the build of a prototype. It contains a visual representation of all fabrication steps and parts.
+* Video
+* BoM
+* ...