Where Can I Find Good Sources of Design Documentation?

  • Thread starter Thread starter Ian_Brooks
  • Start date Start date
  • Tags Tags
    Design
Click For Summary
SUMMARY

This discussion focuses on sourcing effective design documentation for electronic and embedded design projects. Key documents mentioned include Functional Specification Documents, Theory of Operation Documents, Schematic and Bill of Materials documentation, CPLD/FPGA design documentation, and documentation for custom components. These resources serve as essential guidelines for meeting industry standards and tailoring design reports. Participants emphasize the importance of these documents in ensuring comprehensive product documentation.

PREREQUISITES
  • Understanding of Functional Specification Documents
  • Familiarity with Theory of Operation Documents
  • Knowledge of CPLD/FPGA design documentation
  • Experience with Schematic and Bill of Materials documentation
NEXT STEPS
  • Research best practices for creating Functional Specification Documents
  • Explore examples of Theory of Operation Documents in electronic design
  • Learn about CPLD/FPGA design documentation standards and requirements
  • Investigate tools for generating Schematic and Bill of Materials documentation
USEFUL FOR

Engineers, product designers, and technical writers involved in electronic and embedded design projects will benefit from this discussion as it provides insights into essential documentation practices and standards.

Ian_Brooks
Messages
127
Reaction score
0
Can someone direct me to good sources of existing design documentation? Hopefully in electronic/embedded design - I just need to use them as a guideline and see what standards I have to meet when tailoring my design report.

Thanks,
 
Engineering news on Phys.org
I'm not able to send you any of my stuff as examples (proprietary materials owned by the company I work for), but here is a list of some of the kinds of things that will go into product documentation, depending on the product of course:

** Functional Specification Document

** Theory of Operation Document

** Schematic, Bill of Materials, PCB Layout documentation

** CPLD/FPGA design documentation (source code, pin definition file, programming file, programming instructions document)

** Documentation of any custom or unique parts used in the design (like transformers, etc.)


let's see, what else?
 

Similar threads

  • · Replies 22 ·
Replies
22
Views
5K
  • · Replies 4 ·
Replies
4
Views
2K
  • · Replies 6 ·
Replies
6
Views
2K
  • · Replies 11 ·
Replies
11
Views
2K
Replies
5
Views
3K
  • · Replies 3 ·
Replies
3
Views
4K
  • · Replies 11 ·
Replies
11
Views
2K
  • · Replies 15 ·
Replies
15
Views
3K
  • · Replies 7 ·
Replies
7
Views
2K
Replies
11
Views
6K