Sample Design Documentation

[Ian_Brooks]

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,

 

[berkeman]

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?

 

[ravenprp]

Hello,

Thank you for reaching out. There are several good sources for existing design documentation that you can use as a guideline for your own design report. Here are a few suggestions:

1. IEEE Xplore: This is a digital library that provides access to technical literature in engineering and technology. They have a wide range of design documentation for electronic and embedded systems that you can use as a reference.

2. Design News: This is a website that offers a variety of design resources, including white papers, webinars, and case studies. They also have a section specifically for electronic and embedded design.

3. Design World: This is another online resource for design engineers, with a section dedicated to electronic and embedded systems. They offer articles, videos, and white papers that can serve as a reference for your design report.

4. Embedded.com: This is a community website for embedded systems designers, with a wealth of information on design techniques, tools, and processes. They also have a section for design documents and templates that you can use as a guideline.

I hope these sources will be helpful to you in tailoring your design report. Best of luck with your project!