For the 2021-2022 season the file organization and naming scheme has changed to improve clarity, consistency and reduce rebuild errors. The plan this year is to be more strict with the way files are named and stored, don't let this stop you from pushing random files! It is expected that everyone will be unfamiliar with the new system, but after the break in period, everyone should be familiar with the new rules and push files correctly.
Big Changes
Documentation
NO MORE DOCUMENTATION IN THE DRIVE! We have a confluence space for deal with documentation, put all you're documentation on confluence, its nicer here anyways. This will help centralize the location where documentation can be found. This will include catalogues, datasheets, fabrication history, calculations and BOMs. put that in the confluence space not the drive.
Discrepancies
On the last drive, there were a few sub-systems that deviated from standard too far along to be changed after the fact and thus slightly different organizations developed across different sub-system folders. This makes it confusing for members new to the drive or new to the sub-system on where to store files, further deteriorating the file organization.
This year the goal is to be 100% consistent through out the systems and sub-systems. The target is to be consistent enough such that a simple computer program can easily navigate the drive if needed. If your file does not fit within the rules, read the rules again, and if it still doesn't fit, make a rule and document it here.
GrabCAD Issues
One issue with GrabCAD that affects the folder organization are empty folders. For some reason GrabCAD will not sync empty folders. This is described here. TL;DR – GrabCAD won't push you're new empty folders. If you delete a directory it will remove the files from the project but not the now empty folders. Only way to do this is through the website.
Directory Standard
Visual
Note that file names are just for better clarity. The file names are not apart of this standard.
- Folders are colored boxes
- Files have no colored background
- The tail of the arrow indicates the parent directory
Rules
- Only one top level documentation folder
- Only one top level prototyping folder
- Only top level assemblies in the root project directory
- As many as needed sub-system folders w/ or w/out children in the top level folder only.
- Recursed sub-system folders can only exist within an existing sub-system folder.
- A sub-system containing recursed sub-systems shall not contain a 'Components' or 'OTS Components' folder within that directory.
Further Folder Facts
Archive
This is the least organized folder. Any files not in prototyping or used in the main assembly should be moved here. You can check this on the confluence page on moving/renaming Solidworks files.
Sub-System Folders
There are two types: with and without children. The only difference is that the sub-system folders with children contain recursed sub-system folders. This means that these folders will not have a 'Components' or 'OTS components' folder, since they will all be in the recursed sub-system folders. Everything else is the same.
Recursed Sub-System Folders
These folders can only exist within a sub-system folder, or another recursed sub-system folder – hence recursion. These folders only contain the 'Components' and 'OTS Components' folder as well as the assembly file. If there are other recursed sub-system folders within this folder then there will be no 'Components' or 'OTS Components' folder.
Documentation
This is where all project wide files are stored, such as the toolbox, Solidworks library, and file templates. All other documentation should be stored on confluence!
Member Training
This is where all the new members will store their training folders. This is has the same format as last year.
Components
This contains all parts which cannot be bought and used directly on the rover. If an OTS part has to be machined or modified it will go in this folder. Files here shall be named according to the naming scheme.
OTS Components
This is where all OTS (Off The Shelf) components are located (except the ones being modified) The naming convention for OTS components and folder organization within the OTS folder has been outlined in another document on confluence. Try to use the toolbox for all fasteners.
Drawings
This folder is for storing Solidworks drawings and the PDFs of the drawings and nothing else.
Fabrication
this folder contains a set of folders where each folder is a different fabrication order. The naming of each folder inside should be '<company> <date>'. Current state of the fabrication order shall be stored on confluence. Everything the fabricator needs to make the parts should be stored in this folder. This includes: PDFs of drawings, STEP files, STL files and anything else.
PCBs
This where the custom PCBs are stored, the ones designed by the electrical team. If the PCB can be bought OTS then it belongs in the OTS folder. This folder does not need to keep the STEP file, just the optimized PCB .SLDPRT file (Creating Lightweight PCBs).
Renders
This folder stores everything render related with the sub-system.A visual representation of our file structure on Kenesto is shown below:
