Documentation Requirements of Electronic Projects and Assignments

A separate folder (directory) shall be created on your central server to contain all the documentation for an electronic project as listed below. The directory should be accessible electronically for assessment and evaluation, may be required to be added and linked to a web page or archive of projects (or as part of a larger project), and/or may be required to be printed out on paper for assessment and evaluation or as part of a portfolio.

Required Documentation

1.0 Description - (HTML) The description is written in HTML and is the page which all other documentation links to or can be downloaded from.

The Description Page must include;

  • Title
  • Introduction - The introduction may include any background information, where the circuit is used or why the circuit was completed.
  • Description of What the Circuit Does - It may be helpful to think of the circuit in a systems model; Input, Process, Output and Power Supply. You describe all these aspects of the circuit and indicate where the circuit is or could be used.
  • Links to Documentation - There should be links to;
    • download Schematic Drawings
    • link to Bill of Material
    • download Printed Circuit Drawing
    • download Software

The Description Page may include the following sections (if applicable, specifically assigned or required for a level 4 assessment (check rubric));

  • Description of How the Circuit Works - Describe the purpose or function of each component, by functional system.
  • Reference Information

2.0 Schematic Diagrams - (Multisim)

  • These must include a title block and border. The title should match the filename of the file. Notice that MultiSim automatically creates reference I.D. numbers for each element in the schematic diagram. The reference I.D.'s have an letter and a number identifying each component. The letter designates the type of component (R for resistor, Q for transistor, C for capacitor etc.). The number is sequential. If components have been deleted the drawing may contain R2, R3, and R4 for example but no R1. If this is the case the reference I.D.'s must be edited so the components are in sequential series.

3.0 Bill Of Material - (HTML) The Bill of Material (BOM) is written in chart form in HTML.

The BOM must include a column for;

  • Item # - This must match the reference I.D. numbers in the schematic
  • Qty (quantity) -
  • Part Number - For semiconductors the identifying generic part number is indicated. For passive components the value of the component is indicated. (see example)
  • Description - A description of the component is included. (see example)

The BOM may include the following sections (if applicable, specifically assigned or required for a level 4 assessment (check rubric));

  • Details - The best details to include is a specification sheet from the manufacturer for the component. This may be linked to the Internet but it is better to download a spec sheet into your folder (directory) and link to that.
  • Cost - The actual cost of the part at time of fabrication of circuit. This is best in Canadian $.
  • Vendor - If the part can be procured on the Internet then make a link to the supplier and indicate the supplier part number. (This is not necessary for 1/4 W 5% resistors and very standard parts like 1N4001 diodes)

4.0 Printed Circuit Board Drawings (VectorWorks)

  • This drawing should be completed in Vectorworks and have at least three layers;
    • The printed circuit board mask layer should meet the requirements as indicated in Creationg Printed Circuit Board Masks.
    • The title and border layer should be completed in accordance with Title Block and Border Requirements.
    • The components layer should indicate the location and identify the components with the same alphanumeric identifiers as was used in the BOM and the schematic. The components should be located directly above the pcb mask. If the drawing is printed out it shall be printed out twice; once with the title and border and the pcb mask and once with the title and border and the components.

5.0 Software (Various Programs, Flashbasic, Visual Basic, .hex)

  • Software created for the project should be placed in the folder (directory) for the project This includes source code, compiled code and assembled code as required. Links to download these programs shall be created on the description page. Links to freeware on the Internet may also be included if applicable.
Technological Design Home