Category Archives: TAD

Technical Archive Document

TAD Appendix E — Testing Details

1     Organization and Formatting

1.1    General (same as for other B-sheets; follow this link for easy reference)

1.2    Sheet-Specific — Making it All Fit

It’s a blank page; use it however you wish and have as many as needed.  Be sure to keep images and annotations large enough that they are easily read.  Duplicate the page/slide as many times as needed; but keep the first one as the first one as it is the table-of-contents link target.

2     Content Presentation

This is where the details of your testing work are documented.  If it is illegible, it was not done.  Someone picking up from you to carry the work forward must be able to follow the logic (completeness and connectivity) and read it (legibility).

  • There is no specific Page Input textbox/content to be addressed for each of these page(s); however:
    • If work is continuing from the previous page, include an indicator of such at the top left corner in a font size/color that is obvious (e.g., “(continued from previous page)”). Template indicators are provided; delete if not used.
    • When you begin a particular element of work, include in a box (sample provided; move to a logical location) initiating it with a brief statement of WHY you are doing this work (the related engineering requirement(s)) and your plan for how it will be used (if it is a step in a chain of testing/refinement toward verifying something).
  • There is no specific Page Output content to be addressed for each of these page(s); however
    • If work is continued on the next page, include an indicator of such at the bottom right corner in a font size/color that is obvious (e.g., “(continued on next page)”).  Template indicators are provided; delete if not used.
    • When you get to the end of a particular element of work, include in a box (sample provided; move to a logical location) wrapping it up with a brief statement of what you conclude (verification complete or refinement needed).

3     Examples of Great Work

Do a great job and be the first!

© 2017, William J. Endres Updated February 11, 2023

TAD Appendix D — Part and Assembly Prints

1     Organization and Formatting

1.1    General (same as for other B-sheets; follow this link for easy reference)

1.2    Sheet-Specific — Making it All Fit

It’s a blank page; use it however you wish and have as many as needed.  Duplicate the page/slide as many times as needed; but keep the first one as the first one as it is the table-of-contents link target.

2     Content Presentation

This is where your individual part prints and assembly prints are documented.  They should have appropriate borders and placed as a graphic within the border of the template page.

  • Part prints must have material specified, be fully dimensioned and toleranced, and identified with an appropriate name/number and description.
  • Assembly prints must include a bill of materials (BOM) and callouts for each component or subassembly matching its number in the BOM.

As an alternative, if you wish to have a separate file of all your prints, that is fine.  In that case, provide a clear, textual referral here indicating that there is a separate file containing the print package.

3     Examples of Great Work

Do a great job and be the first!

© 2017, William J. Endres Updated February 11, 2023

TAD Appendix C — Supporting Engineering Details

1     Organization and Formatting

1.1    General (same as for other B-sheets; follow this link for easy reference)

1.2    Sheet-Specific — Making it All Fit

It’s a blank page; use it however you wish and have as many as needed.  Be sure to keep images and annotations large enough that they are easily read.  Duplicate the page/slide as many times as needed; but keep the first one as the first one as it is the table-of-contents link target.

2     Content Presentation

This is where the details of your engineering design-support work are documented.  If it is illegible, it was not done.  Someone picking up from you to carry the work forward must be able to follow the logic (completeness and connectivity) and read it (legibility).

  • There is no specific Page Input textbox/content to be addressed for each of these pages(s); however:
    • If work is continuing from the previous page, include an indicator of such at the top left corner in a font size/color that is obvious (e.g., “(continued from previous page)”). Template indicators are provided; delete if not used.
    • When you begin a particular element of work, include in a box (sample provided; move to a logical location) initiating it with a brief statement of WHY you are doing this work and your plan for how it will be used or the sort of conclusion to be drawn (not the specific conclusion, but what sort of conclusion, what it will lead to).
  • There is no specific Page Output content to be addressed for each of these page(s); however
    • If work is continued on the next page, include an indicator of such at the bottom right corner in a font size/color that is obvious (e.g., “(continued on next page)”). Template indicators are provided; delete if not used.
    • When you get to the end of a particular element of work, include in a box (sample provided; move to a logical location) wrapping it up with a brief statement of what you conclude, what the reader should take away from this, where it goes next.

3     Examples of Great Work

Do a great job and be the first!

© 2017, William J. Endres Updated September 21, 2022

TAD Appendix B — System-Level Concept Data/Assessment

1     Organization and Formatting

1.1    General (same as for other B-sheets; follow this link for easy reference)

1.2    Sheet-Specific — Making it All Fit

Each page-pair in this appendix covers a single system-level concept.  Each round has two pages, the second is needed only if you have more than one end-user use case influencing your concept assessment.  There is plenty of room for the two required graphical renderings from DP Manager.  All pages for up to 9 rounds of 5 concepts each are included.  You will delete those pages for rounds not needed once you are sure they are not needed (see guidance at the bottom of each page).

2     Content Presentation

  • There is no specific Page Input textbox/content to be addressed for this/these page(s).
  • Insert graphical renderings from the DP Manager Excel workbook.  Use the copy table buttons on the Excel worksheet (typically the “Copy Table with Heading” button for use in the TAD).  Include:
    • the data table for the subject system-level concept
    • the assessment table for the subject system-level concept (end-user use case 1 only will fit on the first page for each round)
  • There is no specific Page Output textbox/content to be addressed for this/these page(s).

3     Examples of Great Work

Do a great job and be the first!


Excel is a registered trademark of Microsoft Corporation.

© 2017, William J. Endres Updated September 21, 2022

TAD Appendix A — Raw Background Research

Upon completion of the Individual Research Document (IRD) assignment, all content for Appendix A is complete (though it may well get updated over the coming weeks).  Appendix A is a compilation for all team members’ IRDs (the content pages, not the reference pages) into a single appendix.  To do this in Google Slides simply open each IRD file, select the content page/slide in the “filmstrip” (what the left bar is with thumbnails of all the slides is called; if not showing select Show filmstrip from the View menu).  Copy it (ctrl+C), then in the TAD click in the filmstrip after the page/slide the IRD content page is to follow, then paste (ctrl+V).  A popup window will give you choices on what formatting to use; select “Match styles in this presentation” (NOT “Keep original styles” nor “Link & keep original styles”).  If you do this right, the page/slide title should now read (in the TAD) “Appendix A — Raw Background Research”, not “Individual Research Document” as it did in the IRD file.

There are two (2) Appendix-A pages in the template as received.  Do NOT delete or move the first page; it is an introductory page and also serves as the table-of-contents link target.  The second page, at the end, should be retained at this point for future use.  You will copy and paste all IRD content pages between the two aforementioned pages.

You are done with Appendix A, with the exception of updates to any one or all of these pages, and the opportunity to use the additional one at the end, as noted above.


Google Slides is a trademark of Google LLC.

© 2017, William J. Endres Updated September 21, 2022

 

TAD — References

References are presented with the formatting/style noted in Doc-Prep Guidance — Getting Started, and the doc-prep guidance associated with the Individual Research Document (IRD).  Compiling them from multiple or previous source pages involves selecting the actual text (not the textbox) from the source page, putting your cursor in the textbox of the new/destination page where you want to paste it, and pasting it.

The references page is set up as two columns with a left and right textbox.  Please leave it as such.  You will have to manually move references from the left column to the right column once the left column is full, and likewise from the right column of one page to the left column of the next page when the first page is full.

Since it is quite likely that, as a team, you will accumulate more than one page worth of references, the templates are set up with three (3) pages of space for references.

The paragraphs are set up so the reference number (e.g., [FML01]) should be followed by a tab and then the citation (per IEEE format).

© 2017, William J. Endres Updated September 21, 2022

TAD Section 8.3 — Testing and Refinement Summary

1     Organization and Formatting

1.1    General (same as for other B-sheets; follow this link for easy reference)

1.2    Sheet-Specific — Making it All Fit

It’s a blank page; use it however you wish.  But, be sure to use it carefully to fit as much as you can while maintaining clarity and connectivity among the testing results.  You can have up to three (3) pages if needed.  Three pages is enough space, and one page is not significantly more space than needed (i.e., if you have a lot of excess space on a single page, you have likely fallen short, and the remedy is not just making the text and/or figures obnoxiously big to consume space).

2     Content Presentation

  • There is no specific Page Input textbox/content to be addressed for this page.
  • Describe methods used to test the prototype for functional performance and a quantitative assessment of how well performance specifications (each objective and each constraint) are met, or not met.
  • Describe refinements made in the final stages to achieve basic function and/or to improve function toward meeting specifications. Address each requirement.
  • Also include ways the testing itself was improved or could be improved.
  • Be sure to keep images and annotations large enough that they are easily read.
  • Remember this is a summary noting and briefly describing methods used and showing final results and decisions/refinements/conclusions made from each result; the details are in Appendix E.
  • Complete the sheet by populating the Page Output textbox.  Include a couple conclusions or takeaways based on what is on the sheet.  Think of it as answering a reader’s question “so what?” and/or “why should I care?”

3     Examples of Great Work

Do a great job and be the first!

© 2017, William J. Endres Updated September 21, 2022

TAD Section 8.2 — Assembly Highlights

1     Organization and Formatting

1.1    General (same as for other B-sheets; follow this link for easy reference)

1.2    Sheet-Specific — Making it All Fit

It’s a blank page; use it however you wish.  But, be concise enough to not need more than five (5) pages.  Five pages is enough space, and having less than two (2) pages is unusual.

2     Content Presentation

  • There is no specific Page Input textbox/content to be addressed for this page.
  • Referencing detailed drawings/prints in the appendix, describe how the system is assembled step by step. Include CAD renderings and/or actual pictures of the assembly processes/steps.  Someone should be able to replicate your prototype from this section, the bill of materials, and the referenced appendix.
  • Annotate any illustrations and describe any issues encountered and the way they were resolved or could be resolved.
  • Be sure to keep images and annotations large enough that they are easily read.
  • Complete the sheet with the Page Output textbox.  Include a couple conclusions or takeaways based on what is on the sheet.  Think of it as answering a reader’s question “so what?” and/or “why should I care?”

3     Examples of Great Work

Do a great job and be the first!

© 2017, William J. Endres Updated September 21, 2022

TAD Section 8.1 — Part Manufacturing Highlights

1     Organization and Formatting

1.1    General (same as for other B-sheets; follow this link for easy reference)

1.1    Sheet-Specific — Making it All Fit

It’s a blank page; use it however you wish.

2     Content Presentation

  • There is no specific Page Input textbox/content to be addressed for this page.
  • Referencing detailed drawings/prints in the appendix, describe how at least two non-purchased (i.e., not commercial off-the-shelf (COTS)) components are manufactured.
  • Annotate any illustrations and describe any issues encountered and the way they were resolved or could be resolved.
  • Be sure to keep images and annotations large enough that they are easily read.
  • Complete the page by populating the Page Output textbox.  Include a couple conclusions or takeaways based on what is on the page.  Think of it as answering a reader’s question “so what?” and/or “why should I care?”

3     Examples of Great Work

Do a great job and be the first!

© 2017, William J. Endres Updated September 21, 2022

TAD Section 7.2 — Design-Decisions Summary

1     Organization and Formatting

1.1    General (same as for other B-sheets; follow this link for easy reference)

1.1    Sheet-Specific — Making it All Fit

Adjust the page however you want by resizing boxes.  Be sure to keep images and annotations large enough that they are easily read.  Be sure to include images; there is plenty of space for images.

2     Content Presentation

  • Commence this page by populating the Page Input textbox. In this case, the page input includes conclusive elements from your detail-design engineering work that are relevant to the areas of design decisions covered here.
  • Provide descriptions of design decisions made in regard to the three specific, always relevant Decisions and Features Specifics are as follows:
    • Safety-Driven Decisions and Features:   Safety is of utmost importance in any product or service. Describe features of your concept and the related design details intended to ensure safety, as well as any specific analyses that support realization of a safe-to-use product or process.  Demonstrate the ways safety considerations influenced your design decisions.
    • Manufacturability-Driven Decisions and Features:  Describe detail-level and system-level/concept-level decisions made to facilitate ease of manufacture of components and their subsequent assembly into the system. Use engineering data to support your decisions.
    • Material-Selection Decisions and Features:   Justify decisions regarding material selection for key components, with reference to results from the detail-design engineering work-product.  Note any material substitutions made for the purpose of prototype manufacturing (e.g., use of a wrought alloy machined for the prototype versus use of a casting (of cast alloy) for the final product).  Justify that the substituted material should be sufficiently representative of the material intended for the final product.  Considerations include:
      • availability of materials
      • availability of facilities (internal and/or outsourced) to work with certain materials
      • impact of both materials and facilities on manufacturability
      • other materials considered but not used and the reason(s) they were discarded as options
    • Other Decisions and Related Features: For each item below, briefly summarize the ways in which each item influenced (or did not influence) your design decisions.  In this list, unlike the three specific, always-relevant ones noted above, there is greater likelihood (though still relatively rare) that a topic is not applicable.  But, in that case, you must convincingly justify it.  Anything addressed as an afterthought rather than during the early design stages should be noted as a “late-stage enhancement.”
      • Reliability:  What steps has the team taken to determine if the final design is reliable? Whether process or product-oriented, each project has potential reliability issues.
      • Maintainability and Serviceability:  Discuss what steps the team took to ensure the design is low-maintenance and easy-to-service when maintenance is needed. Examples include construction with “commercial off-the-shelf” parts, simple assembly and disassembly processes, standard sizing of components, etc.
      • Aesthetics:  Includes any considerations made in regard to physical appearance, but from a design standpoint, not a matter of visual quality of workmanship. While visual quality is important, focus here on choices made to benefit the end-user, i.e., design of a controller or interface, color scheme, etc.
      • Human Factors:  The focus here is how a human interfaces with the device/system, physically, cognitively, etc. Things to consider, for example, are placement of controls, placement of indicators, repetitive motions, ease of motions, potential for mental errors, minimization of physical error opportunities (physical interface robustness) in general.
      • Environmental Sustainability (including Retirement, Reuse and Remanufacture):  While this may not be relevant for all projects, most projects have some type of environmental impact. Discuss possible impacts and the ways the team has addressed them in the final design.
  • There is no specific Page Output textbox/content to be addressed for this page.

3     Examples of Great Work

Do a great job and be the first!

© 2017, William J. Endres Updated September 21, 2022