Final Project Documentation¶

A complete technical data package consists of more than text. The data package should also include a variety of items depending on the nature of the project work.

If producing a CD/DVD for your Client, then a separate index listing of all files on disk could be generated to help the recipient of the disk verify that its readable. In general, we do not produce CD/DVD media.

In all cases below, be sure to include the material in it's original editable file format! For example, Word documents must be in DOCX format, not just a PDF. This is true for all diagrams, CAD, simulations, etc. Others need to be able to edit & reproduce your work which they cannot readily do from a PDF or graphic image file.

2D / 3D models¶

1. The complete model(s) and assemblies
2. 2D engineering drawings made from the models
3. Final fabrication drawings as issued to the shop

Drawing sets¶

For completeness, the set of drawings should include

1. Drawing as the cover page / index to the drawing package
2. A clearly defined file naming convention
3. Assembly drawings
4. Bill of Material drawing / table

Software¶

1. Complete source code listing
2. Doxygen or similar documentation output
3. Development environment details / configuration / settings
4. Change management system information, ex: subversion, repository name
5. for C/C++ and similar languages
   1. Makefiles for each appropriate directory (reconstructs this portion of the project)
   2. Overall project-wide makefile (run this alone to generate a fresh copy of the entire project)

Electronics¶

1. Complete schematics (KiCAD, Eagle CAD, etc.)
2. Wiring diagrams (typically photos)
3. Printed circuit board layouts (from KiCAD, Eagle CAD, etc.)
4. Proto board layouts (typically photos or CAD generated graphics, ex: Fritzing)

Miscellaneous¶

1. Photographs of the project during assembly / disassembly
2. Photographs of the completed project
3. Demonstration videos of all / parts of the project