Getting started as documentation person

From Open Source Ecology
Jump to: navigation, search

Overview[edit]

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[edit]

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[edit]

Documentation types[edit]

  • 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
  • ...