File Naming - VTAstrobotics/Documentation GitHub Wiki

Contents

Purpose

This naming system is meant to simplify finding and communicating about CAD files. Each file is given a unique number that communicates information about the file and makes it easy to find in the file explorer. The rules for making the file name are meant to be simple and flexible.

Structure

Every file should follow the following structure:

SS-AA-PP-II_Description

What does each part stand for?

  • SS: Subsystem

    00 = Overall System

    01 = Drive/Chassis

    02 = Dig

    03 = Dump

  • AA: Assembly number

    • This should start with the number 10, 20, 30, ..., ect.
    • The part number should be 00 for assemblies.
    • When there is an sub-assembly within one of the top level assemblies (10, 20, 30, ...) they should follow sequentially (11, 12, 13...)

    Example: 01-10-00_EXAMPLE is the first assembly of the Drive/Chassis subsystem

    01-11-00_EXAMPLE Would be the first sub-assembly in the 01-10-00

    01-11-01_EXAMPLE Would be the first part in the sub-assembly

  • PP: Part number

    • This should start with the number 01 and go sequentially up as you add more parts into the assemblie.
    • The parts in the first assembly of the Drive/Chassis would look like this:

    01-10-01_EXAMPLE, 01-10-02_EXAMPLE, 01-10-01_EXAMPLE, ect.

  • II: Identification number

    • This should only be used when there is something that can't be captured with the rest of the numbers
    • Like a mirror version of a part or a different file type (DXF, STL, ect.)
    • It can be left off otherwise

    Example: 01-10-01-01_EXAMPLE_DXF

  • Description

    • It should have a "_" before the description and should have no spaces.
    • "_" should be used instead of spaces
    • Keep descriptions short two to four words/numbers so they will fit in tables and title blocks.

Using this naming system results in a file that looks like this:

image

(This example is the Drive/Chassis subsystem from the 2022-2023 season and will be used throughout the CAD documentation because it is awesome)

Generally this system organizes parts and assemblies by what they are components of.

Example:

01-23-45 is the 45th part of the assembly 01-23-00 which is a subassembly of 01-20-00 which is an main assembly of 01-00-00 which is a subsystem of 00-00-00 the complete robot.

image

Why it works?

The naming system works because the file explorer sorts files (when you sort by name) in this order

  1. Symbols (eg. ~, -, and _)
  2. Numbers (small to large)
  3. Letters (alphabetical)

Stock Parts

98 McMASTER-CARR

97 Andy Mark

96 Flipsky

Recommendations:

  • The description should be a plane English description of the file that anyone with a reasonable technical background can understand (eg. BASE_PLATE or M4_SOCKET_HEAD)
  • All letters should be uppercase unless that would interfere with the meaning (eg mm, in, or letters in stock numbers)
  • You do not need to include what assembly or subsystem the file is related to as this should be taken care of by the number.
  • For stock parts include the stock number at the end of the description for redundancy.