NBEAA Open Source Electric Vehicle Program
DOCUMENTATION STANDARDS
Updated 4/7/09

Key Specifications
1. Payload, in number of seats, doors, car size, body style and weight
2. Acceleration, time to 60 MPH or 100 km/h
3. Top speed
4. Range
5. Battery capacity
6. Battery current at top cruising speed
7. Charge time and current draw at 240V and 120V
8. Other features

EV Component List
9. Reference designator
10. Make
11. Model
12. Description
13. Link to datasheet
14. Link to manual, if there is one
15. Quantity
16. Unit of measure
17. Supplier
18. price
19. Tax
20. Shipping
21. Total

Reference Designator Key
22. BT = battery
23. C = capacitor
24. D = diode
25. F = fuse
26. J = jack (female connector)
27. K = relay, including contactors
28. L = inductor
29. MP = mechanical part
30. P = plug (male connector)
31. PS = power supply -- motor controller, DC-DC converter or charger
32. Q = transistor
33. R = resistor
34. S = switch
35. T = transformer
36. U = integrated circuit
37. W = wire or wire assembly
38. X = other
39. Y = crystal

Wire Color Abbreviations
40. BLK = black
41. BRN = brown
42. RED = red
43. ORN = orange
44. YEL = yellow
45. GRN = green
46. BLU = blue
47. VIO = violet
48. GRY = gray
49. WHT = white

Wiring Diagrams
50. All components assigned a reference designator
51. List make and model for unique components
52. All pins labeled with name and number as applicable to exactly match manual
53. All wires or circuit traces named directly, by their connector name, or inferred i.e. GND for downwards arrows
54. All wire colors, gages, terminations and notes in wiring list
55. All wire and trace junctions marked with large solid dot
56. All wire and trace crossovers that are not junctions not marked with hoops
57. Easily viewable and readable on computer without scrolling
58. PDF file format for viewing
59. Easily printable on 8.5' x 11" printer paper; larger drawings broken up
60. Separate assembly drawing to find reference designators on assembly as they appear physically

Printed Circuit Boards
61. Standard *.SCH file format for circuit boards for editing and layout derivation
62. Editable with common, full featured, reasonably priced software, such as CadSoft Eagle for circuit boards, but also with freeware alternatives
63. Standard *.PCB design file for editing in programs such as CadSoft Eagle
64. Standard Gerber file output usable by most PCB manufacturers (want); ExpressPCB's free software OK due to low cost prototyping

Mechanical Drawings
65. 2D dimensioned with tolerances
66. 2D material list with make, model, description and quantity
67. 2D special fabrication or assembly instructions provided
68. 2D easily viewable and readable on computer without scrolling
69. 2D PDF file format for viewing
70. *.DWG Autodesk Autocad compatible files for editing and fabrication
71. 3D solid model for CAD machinable parts, if possible (want)

Software
72. Microcontroller code written in C
73. PC program code written in TBD
74. Source code posted with ample comments suitable for classroom instruction
75. Modular, small code when possible
76. Programming instructions
77. Development environment setup instructions
78. Development environment reasonably priced with ample support
79. Robust source control and configuration management
80. Posted QA plan and results per module

Other Documentation
81. Block Diagrams -- electrical, mechanical and SW
82. Theory of Operation for both HW and SW
83. Assembly Instructions
84. Verification Test Procedure
85. Users' Guide
86. Maintenance Guide
87. Troubleshooting Guide
88. Repair Procedures
89. Frequently Asked Questions

Common to All Documentation
90. Revision date
91. Open source
92. Downloadable via web
93. Hard copies set up as on-demand, not bulk printing