Wednesday, November 30, 2011

Engineering Method of Documentation


  1. Make it easy to read/understand. Lists are good. Figures are good. 
    1.  Make the English correct. Typos get on the reader’s nerves (at least they do if I’m the reader).
  2. Explain the reasoning. Decision diagrams help with this. Charts as well. 
  3. Explain the topic. Flowcharts are good. Block-diagrams as well. Text should complement everything else. 
  4.  Do research. A project that doesn’t involve research probably isn’t worth doing. 
  5.  Do analysis. See “research.”
  6. Be concise.

No comments:

Post a Comment