Documentation Standards

From Open Source Ecology
Revision as of 13:41, 26 June 2011 by William Neal (talk | contribs)
Jump to navigation Jump to search

Introduction

June 2011 marks a point of shifting the focus to professional documentation standard development at Factor e Farm. We are at the stage that such documentation is not only indispensable for production runs at Factor e Farm, but also for replication in other places worldwide.

Documentation Standards

We propose the following procedure for developing documentation based on prototyping work at Factor e Farm.

  1. Upload all media to FTP repository
  2. Publish detailed fabrication procedure on wiki
  3. Fill in with pictures, jpg of CAD files, and links to actual CAD and CAM files in file repository
  4. Develop an instructional video based on wiki fabrication procedure and any additional material from media FTP repository

Documentation at Other Locations

As other locations come online, similar procedures should be implemented to facilitate contributions to the overall project.