1.7 KiB
I think the best development and documentation approach is the following:
-
README: detailed documentation of everything, version controlled with iterations. We can also have multiple .md files instead of just one.
-
requirements
-
design decisions
- components search (IC comparison, connectors, etc.
-
Bringup instructions
-
soldering instructions
-
debug instructions
-
reference to design documents (e.g. from TI) in resource folder
-
Software needed to use the pcb (maybe link to board software package repository)
-
-
gitlab:
-
track possible requirements for future iterations as issues tagged with
requirement -
track issues during reviews --> also acts as discussion for design decisions --> when decision is taken, the issue should be referenced in the README
-
-
confluence: We can also track this in gitlab as CONFLUENCE.md and then import it into confluence
-
have a summary of the README that is focused solely on the usage of the pcb.
-
should look like a datasheet:
-
min max voltage, min max current, etc.
-
minimum connections needed
-
if needed instructions on how to flash software or use software to program correctly
-
-
Should have a small troubleshooting guide that links to more detailed instructions in the README
-
should have a dos and donts section: what not to do at all costs.
-
-
Finally the google drive should be used solely for PCB Testing and detailed test documentation with the templates that we have for development