Skip to content

Folder structure

Jump to bottom
Roman Isaikin edited this page Nov 8, 2025 · 3 revisions

Simplified folder structure

  • b001_short_description/
    • spec/ - block diagrams, specifications, requirements
    • source/ - CAD files, one folder per revision
      • b001a/
      • b001b/
    • change/ - Changelists in Markdown format, schematic, layout, test points and BOM diffs.
      • change_b001a.md - initial, mention previous projects and changes from them, if any
      • change_b001b.md - from rev.A to rev.B

(only revision A is created, B shown for clarity on how to continue using this folder structure)

Full folder structure

  • b001_short_description/ (provide description to quickly find things, only here to change it easily if need be)
    • spec/ - block diagrams, specifications, requirements
    • source/ - CAD files, one folder per revision
      • b001a/
      • b001b/
      • lib/ - project specific library parts
        • Setup a script to generate QR code with URL to board docs
    • test/ - test plans
      • List of names and test points connected to them
      • Test scripts, ideally referencing version controlled test procedures only providing specific values to them
    • change/ - Changelists in Markdown format, schematic, layout, test points and BOM diffs.
      • change_b001a.md - initial, mention previous projects and changes from them
      • change_b001b.md - from rev.A to rev.B
    • docs/ - Datasheets for used parts, reference manuals.
      • Markdown file with links as an alternative to storing big files directly in git.
    • errata/ - Known board issues and workarounds. Rework guides. Optionally per-board-serial changes made.
      • errata_b001a.md - known issues for rev.A and possible workarounds. Mention PCBA serials that are modified
      • mod_b001a_sn010203.md - specific modifications made to the PCBA with specified SN or SN range.
    • fab/ - Fabrication data
      • gerbers/ - zip of Gerbers. Actual files to be ignored to save repo space and make sure files are sent as one unit.
        • gerbers_b001a.zip
        • gerbers_b001b.zip
      • bom/ - CSV and/or XLS BOMs, add date and variant if used to each file, as BOMs could change for the same revision as part availability change.
      • drawings/ - Assembly drawings, via charts if needed, test points DXF, contour DXF
      • assembly/ - Pick and Place files
      • netlist/ - Netlists in one or several formats?
    • pdf/
      • Schematics - sch_b001a_variant_01jan2025.pdf
      • Layout prints (one pdf, each layer on separate page)
    • release/ - Everything as one 7z archive for each revision?
    • graphics/ - PCB renders from top, bottom, isometry and maybe all sides as well. PNG in highest compression?
    • mech/ - mechanics related files
      • STEP (not compressed, since it's text based, git should be able to handle it well)
      • Blender export if setup
      • Top and bottom silk as images?
      • Test points DXF, countour DXF here (with dimensions and holes diameters)
      • IDF if used
      • STEP height map - simplified board with extruded bounding boxes,
      • SVG height map?
    • report/ - DRC and ERC reports, script to raise an error on gerber export if there are errors
      • Test points coordinates in CSV
      • IBOM here?
      • Bring up report
        • Generate template from CLI command
      • Other better-erc reports here

Clone this wiki locally