V Admin Standards

Naming Files & Folders

All CUInSpace hardware must have appropriate file and folder names to ensure consistency across designs and board versions.

Eagle schematic and board file names will appear as follows: XXX_REVY.brd / XXX_REVY.sch

Where XXX is the three letter designation for the board (ex. CON, PWR, NSC) and Y is a letter used to identify the revision of the board (ex. A, B, C).

Eagle libraries including unique ICs used in designs should also be included in the folder. These libraries should be named XXX_REVY.lib, adhering the rules defined above.

Folders for boards should use the full name of the board, and should be all lowercase with no spaces (ex. connector, power, nosecone).

Board Documentation

All CUInSpace hardware must have documentation. Both executives and regular members need to take notes on their work so new students can learn and understand the avionics system quickly. Proper documentation will also allow for faster development of hardware systems.

This documentation must exist in two places:

1. In your eagle schematic file. Outline circuit elements, briefly describe what each part of a board does, and its inputs and outputs. You do not need to walk through your design process, just make sure that someone can look at the schematic and understand how the big pieces go together.
2. In the avionics-hardware wiki. See the "Stack Hardware in Detail" section. A revision of the board description must be made. Update any changed connections, ICs, or other relevant elements in this section and send a copy of the revised text to a github admin to update the section.

Note about documentation: Providing hardware documentation is the responsibility of the designer. You MUST provide the documentation for your board, do not expect a team lead to provide it for you, as they likely have no idea how your design works.