Main Page

Current

Does not exist.

Proposed New Documentation structure

Documentation should be moved to the box, its dumb to be keeping external pdf's under version control

Version Control

This is the file structure I would like us to adopt,

  • Folder Name
  • content description
  • [Generic text to represent multiple structures]
  • CAD
    • 3D modeling of the structure and components
    • Thermal
      • Thermal FEM (Simplified meshes for thermal)
      • Thermal Analysis (Space Systems Thermal .sim files)
    • Vibration
      • Vibration FEM (Vibrational meshes with bolt connections)
      • Vibration Analysis (NASTRAN .sim files)
  • [Subsystem Name]
    • Software
      • Active
        • [SatelliteName_SubsystemName_BoardName_Rev] Firmware
          • Any Active code project, (firmware)
        • Scripts
          • Currently used scripts
          • Test scripts, etc
        • Simulation
          • Simulations, Pspice, GNU radio, link/power budgets, etc.
      • Archive
        • Code for last revision of hardware in a zip folder
        • No longer relevant scripts, in a zip folder
    • Hardware
      • [SatelliteName_SubsystemName_BoardName_Rev]
        • Altium Project for current revision built and under hardware test
      • [SatelliteName_SubsystemName_BoardName_Rev] Documentation
        • PCB Artwork
        • Gerber Files
        • Bill Of Materials
        • Release Checklists
      • [SatelliteName_SubsystemName_BoardName_Rev] for systems with multiple boards, ie power has solar panels, storage, and regulation
      • [SatelliteName_SubsystemName_BoardName_Rev] Documentation for systems with multiple boards, ie power has solar panels, storage, and regulation
    • Archive
      • old revisions no longer used in development or test (ie older than revision n-1) zipped
    • Documentation
      • The subsystem data sheet (Not Component Data Sheets, we want to have a document that basically summarizes the operation of the system and lists interfaces and pins for people working on firmware or trying to interface with the system from another one) and any design excel sheets, talks briefly about requirements and data and command handling, must link to the location on box that all supporting data sheets and documents are

[SatelliteName_SubsystemName_BoardName_Rev]

I know the [SatelliteName_SubsystemName_BoardName_Rev] format seems long but it will make more sense as we begin to reuse systems and designs for future rounds of the CSDC. If we use this format it will be easy to determine what satellite, what system, what board, and what revision the design is, so what mentioning the board in documentation it becomes very easy to trace in comparison to project names such as Digital Board - Pic32 Modified which is the current most recent modem board for the ECOSat2 satellite.

Box

  • [Subsystem Name]
    • Data sheets
      • Any relevant data sheet to the current in development/testing and in layout boards
    • Internal Reports
      • Current
        • Any relevant co-op reports or design reports (like the final RF report) for the system or at least a list of the relevant ones in the co-op folder that are true to the current design.
      • Out of date
        • Any relevant co-op reports or design reports (like the final RF report) for the system or at least a list of the relevant ones in the co-op folder that no longer represent the current design.
    • Reference
      • Any relevant white papers or references on the system
    • Media
      • Pictures and Video specific to the subsystem
    • Archive
      • Any really old documentation or design files for the subsystem, we have a ton of stuff floating around since 2011
Navigation
Print/export
QR Code
QR Code file_structure (generated for current page)