Description: Procedure for Design Documentation

        This acts as a guideline for design documentation. It conveys why 
    structured text is used within a design document. It list and describes 
    the expected structures including Description, Design, Bill of Materials.


Table of References:
     Proc0001


Table Of Contents:
     SECTION A: What is in a Design
     SECTION B: Modular Structures
     SECTION C: Expected Order
     CHANGE LOG: History


Sign-Off List:
    Position Responsible     |    Name                 |   Date             
    -------------------------+-------------------------+--------------------
    Designer                 |                         |         
    -------------------------+-------------------------+--------------------
    Validation               |                         |
    -------------------------+-------------------------+--------------------
    Location/Site Management |                         |
    -------------------------+-------------------------+--------------------
    Note: in point of fact a sign-off list is used to cover your ass, and is not
        used at epccs, however if it is needed some day...



SECTION A: What is in a Design

        In simple terms a Design is information about how something is assembled.
    Designs tell what parts, methods, and connections to use. Mechanical designs 
    generally require graphical representations or data files. Electrical 
    designs require graphical files for schematics, board layout, as well
    as textual software source files. Purely software designs are ideally 
    textual source files, and are kept in a configuration management system.



SECTION B: Modular Structures

        Description is a simple summary of the Design, and should include key
    areas of interest, while remaining concise.

        Table of References is a list of the reference documentation. This can 
    include Hyperlinks and if needed additional text, however care must be 
    exercised to not obfuscate.

        Table Of Contents list the sections that follow. Enumeration is allowed, 
    but not required. If enumeration is not used then indentation is used to
    indicate the beginning and changing of sections. Design documents should be
    structured, but need not have a clean room like feel.

        Design section provides or indicates details including connections,
    mechanical drawing (or more likely references), and anything that aids 
    in the understanding of a design.

        Bill of Materials is a list formated as follows: "[reference] [(usage)]: 
    [manufacture] [p/n], ["description"]". Usage is optional. No spaces are allowed
    except in the description string. Replace spaces with underline (" " = "_") 
    as needed in p/n, manufacture, or reference. Usage is indicated as each (ea),
    or a unit of measure, thus meter (m), kilogram (kg). Old English units, thus
    foot (ft) and pounds (lbs) are not preferred however they are used all over
    the place in these documents, so knowledge of conversion is required.

        Notes are provided in some designs for all sorts of reasons, and may
    or may not be important or use, assembly, or maintenance.


SECTION C: Expected Order

        Follow the same order as presented above


CHANGE LOG: History
    $Id: index.html,v 1.4 2008/05/26 05:27:25 rsutherland Exp $ Release New
    Initial release
    

Copyright Notice

    Copyright (C) 2007 Ronald Steven Sutherland
    To report errors or omissions http://epccs.com/contact.php
    Permission is granted to copy, distribute and/or modify this document 
    under the terms of the GNU Free Documentation License, Version 1.2 or 
    any later version published by the Free Software Foundation; with no 
    Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A 
    copy of the license is included in the section entitled "GNU Free 
    Documentation License".
    
    GFDL taken form http://www.gnu.org/copyleft/fdl.html