Documentation Strategy: Difference between revisions

From Open Source Ecology
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
=Master Documentation Plan=
=Master Documentation Plan=


[[File:Master_Documentation_Plan.pdf|Master Documentation Plan]]


=What is Documentation=
''This is what a final product release document should contain.''
<br/>
===Understand It===
''This section is a holistic story of the tool''
#What Is It Used For?
#*Problems the machine addresses
#*How the machine improves our lives
#How Does It Work?
#*What are the physics behind this machine?
#*What is the rationale behind the machine’s design?
#History Of This Tool
#*Social History
#*Inventor Crediting


Documentation is about information storage in preparation for information transfer.
===Build It===
''Step by step breakdown of how to manufacture this tool.''
#Overview of entire process
#:''This is useful for a remote FabLab to know what exactly to invest in before entering the enterprise.''
#*All tools needed
#**Sourcing
#*All materials needed
#**Sourcing
#Chronological Process Breakdown
#:''Standard format operations manual similar to those included with consumer and professional devices. Includes images and videos for each operation''
#*<span style="color:green">Tools Needed</span>
#*<span style="color:green">Materials Needed</span>
#*Step-by-step manufacture instructions


=Documentation Strategy Summary=
<blockquote style="background-color: lightgrey; border: solid thin grey;"><span style="color:green">GREEN TEXT: Documenter decides whether this is necessary depending on specific process</span>
<br/>
Possible keywords for process breakdown
:*Making Components (Fabrication?)
:*Assembling Components (Assembly?)
:*Painting & Finishing
:*Material
:*Electronic
:*Hydraulic
:*Biological
:*Neurological
:*Quantum
:*Software
</blockquote>


Quality content, quick navigation, and ease of editing.
===Use It===
''Standard format operations manual similar to those included with consumer and professional devices. Includes images and videos for each operation''
#Operations Manuals
#*Operations Manuals Keywords
#*#Advanced User
#*#Basic User
 
===Troubleshoot It===
''Known issues and community base for troubleshooting and repairs.''
#Known Symptoms and their causes in a wiki (any logged-in user can edit)
#Community Discussion Page (Forum style)
#*Topics -> Threads -> Discussions
#*Community Q/A Page
#*A Question -> Multiple answer format with best answer voting system

Revision as of 02:29, 28 June 2012

Master Documentation Plan

This is what a final product release document should contain.

Understand It

This section is a holistic story of the tool

  1. What Is It Used For?
    • Problems the machine addresses
    • How the machine improves our lives
  2. How Does It Work?
    • What are the physics behind this machine?
    • What is the rationale behind the machine’s design?
  3. History Of This Tool
    • Social History
    • Inventor Crediting

Build It

Step by step breakdown of how to manufacture this tool.

  1. Overview of entire process
    This is useful for a remote FabLab to know what exactly to invest in before entering the enterprise.
    • All tools needed
      • Sourcing
    • All materials needed
      • Sourcing
  2. Chronological Process Breakdown
    Standard format operations manual similar to those included with consumer and professional devices. Includes images and videos for each operation
    • Tools Needed
    • Materials Needed
    • Step-by-step manufacture instructions

GREEN TEXT: Documenter decides whether this is necessary depending on specific process


Possible keywords for process breakdown

  • Making Components (Fabrication?)
  • Assembling Components (Assembly?)
  • Painting & Finishing
  • Material
  • Electronic
  • Hydraulic
  • Biological
  • Neurological
  • Quantum
  • Software

Use It

Standard format operations manual similar to those included with consumer and professional devices. Includes images and videos for each operation

  1. Operations Manuals
    • Operations Manuals Keywords
      1. Advanced User
      2. Basic User

Troubleshoot It

Known issues and community base for troubleshooting and repairs.

  1. Known Symptoms and their causes in a wiki (any logged-in user can edit)
  2. Community Discussion Page (Forum style)
    • Topics -> Threads -> Discussions
    • Community Q/A Page
    • A Question -> Multiple answer format with best answer voting system
Retrieved from "https://wiki.opensourceecology.org/index.php?title=Documentation_Strategy&oldid=67701"