User Tools

Site Tools


project-wiki:artifacts:design_artifacts

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
project-wiki:artifacts:design_artifacts [2021/11/10 15:54]
127.0.0.1 external edit
project-wiki:artifacts:design_artifacts [2023/08/31 15:53] (current)
mlhicks
Line 1: Line 1:
-<-Artifact Overview ^home|Artifacts^Requirements Artifacts->+<-decision_levels|Decision Levels and Artifact Overview ^home|Artifacts^engineering_drawing_standards|Engineering Drawing Standards->
 =====Design Artifacts===== =====Design Artifacts=====
  
Line 16: Line 16:
   * Bill of Materials:    * Bill of Materials: 
     * Hardware: A bill of materials (BOM) is a table showing all parts in your design in a hierarchical structure with top assembly, subassemblies, and parts. The BOM also has information regarding each part such as a part number, a drawing number, and a source for the part. The BOM can also be used to track the completeness of the project. It is a good idea to add cells to the table indicating whether or not parts are currently on order, being machined, tested and approved, or completely done.   More information on the BOM, including a sample BOM, is found in the Development Reference of the textbook under Bill of Materials. A BOM Template is provided on Box under Class Documents/Templates.     * Hardware: A bill of materials (BOM) is a table showing all parts in your design in a hierarchical structure with top assembly, subassemblies, and parts. The BOM also has information regarding each part such as a part number, a drawing number, and a source for the part. The BOM can also be used to track the completeness of the project. It is a good idea to add cells to the table indicating whether or not parts are currently on order, being machined, tested and approved, or completely done.   More information on the BOM, including a sample BOM, is found in the Development Reference of the textbook under Bill of Materials. A BOM Template is provided on Box under Class Documents/Templates.
-    * Software: A software bill of materials (SBOM) (see [[http://ntia.gov/SBOM|NTIA definitions]]) is the software hierarchy and dependency list with appropriate libraries and test scripts. It shows how the different software elements are interconnected and allows future users to examine dependencies, especially when dependent libraries are updated external to the project and may cause linking errors. See how this fits into [[..tools:Software Projects]].+    * Software: A software bill of materials (SBOM) (see [[http://ntia.gov/SBOM|NTIA definitions]]) is the software hierarchy and dependency list with appropriate libraries and test scripts. It shows how the different software elements are interconnected and allows future users to examine dependencies, especially when dependent libraries are updated external to the project and may cause linking errors. See how this fits into [[..software_projects:home]].
  
   * List of Parts to Purchase: Late in the first semester or early in the second, teams should have identified which parts of their design will be purchased from vendors rather than designed by the team. Developing this list and sharing it with your sponsor can be helpful to get approval for increased budget necessary to complete your project. You may also need to purchase specific software, libraries, or IP blocks necessary to complete your project. This may be part of the Bill of Materials, rather than a separate item.   * List of Parts to Purchase: Late in the first semester or early in the second, teams should have identified which parts of their design will be purchased from vendors rather than designed by the team. Developing this list and sharing it with your sponsor can be helpful to get approval for increased budget necessary to complete your project. You may also need to purchase specific software, libraries, or IP blocks necessary to complete your project. This may be part of the Bill of Materials, rather than a separate item.
Line 23: Line 23:
 ====Mechanical Designs==== ====Mechanical Designs====
  
-The following artifacts are typically required whenever there is a mechanical component to the design.Note that these artifacts should have a filled-out Title Block and other non-graphical information as described in [[engineering_drawing_standards|Engineering Drawing Standards]].+The following artifacts are typically required whenever there is a mechanical component to the design. Note that these artifacts should have a filled-out Title Block and other non-graphical information as described in [[engineering_drawing_standards|Engineering Drawing Standards]].
  
   * Assembly Drawing or Sketch with Ballooned Parts: At the end of Concept Development the design will include a sketch of the complete assembly for the selected design concept. This helps those not intimately involved in the project understand the main physical sections and the parts that comprise it. This is fundamentally important when your liaison shares your selected concept with others in the organization. A numbered balloon points to each part in the concept and is named and described briefly in text.  This sketch will later be replaced by assembly drawings.   * Assembly Drawing or Sketch with Ballooned Parts: At the end of Concept Development the design will include a sketch of the complete assembly for the selected design concept. This helps those not intimately involved in the project understand the main physical sections and the parts that comprise it. This is fundamentally important when your liaison shares your selected concept with others in the organization. A numbered balloon points to each part in the concept and is named and described briefly in text.  This sketch will later be replaced by assembly drawings.
Line 63: Line 63:
 ====Software==== ====Software====
  
-The following artifacts are typically required for products having a custom software component. Be sure to refer to [[software_artifacts|Software Artifacts]] to learn about version control methods that apply to software.  Make sure your methods are consistent with the requirements of your sponsor. See [[software_artifacts|Software Artifacts]] for how source code should be stored in your [[project_data_archive|Project Data Archive]].+The following artifacts are typically required for products having a custom software component. Be sure to refer to [[software_artifacts|Software Artifacts]] to learn about version control methods that apply to software and how source code should be stored in your [[project_data_archive|Project Data Archive]].  Make sure your methods are consistent with the requirements of your sponsor.
  
   * Logic Diagrams: When software forms an important part of the product, logic diagrams of the software should be part of the drawing package. This may include diagrams such as flowcharts, UML diagrams, ladder diagrams, pseudocode, and block diagrams. The objective is to document the logic that is implemented in the software. Use standard symbols in logic diagrams.   * Logic Diagrams: When software forms an important part of the product, logic diagrams of the software should be part of the drawing package. This may include diagrams such as flowcharts, UML diagrams, ladder diagrams, pseudocode, and block diagrams. The objective is to document the logic that is implemented in the software. Use standard symbols in logic diagrams.
project-wiki/artifacts/design_artifacts.1636584890.txt.gz ยท Last modified: 2021/11/10 15:54 by 127.0.0.1