10 Replies Latest reply on Nov 16, 2019 10:07 PM by colporteur

    Documentation of projects

    brianchilders

          What are some tools that you use to document projects?

       

      For example, when I look at projects online, they often have a BOM (Bill of Materials) as well as pictures of the project.

       

      But when it comes to documenting the actual schematics, this is an area where I see less of.  I understand that there may be varying levels of experience, but as I share my ideas here, I would like for others to easily build or reproduce what I've done.

       

      In addition to technical schematics, is there a program that makes a "pretty picture" e.g. how parts might be laid out on a breadboard?

       

      Thanks for your help!

       

      -brian

        • Re: Documentation of projects
          ralphjy

          There is a free open-source program called Fritzing https://fritzing.org/home/ that will allow you to create a graphical breadboard image that corresponds to a schematic. 

          8 of 8 people found this helpful
          • Re: Documentation of projects
            shabaz

            Hi Brian,

             

            There's a few breadboard diagramming applications, I believe Fritzing will do it. For stripboard layouts (i.e. similar-ish to breadboard) I've use Lochmaster once, it is not free software, but as long as you're ok not saving your project, then you can use the free demo version and click the Print Screen button to copy the output to your clipboard, and then paste into MS Paint etc., to save it. It is ok-ish. I just used the free version, to me it wasn't worth the asking price because I rarely draw such diagrams (there's huge scope for errors if people rely on bradboard layouts alone, without knowing IC pin numbers etc., so at some point if they can, then they may as well start examining real schematics. But the schematic may not be enough, since interpreting a schematic is likely not possible for projects intended for children or beginners in electronics.

             

            PowerPoint is an option too. This diagram was done with it (showing connections between dev-boards for example):

            I like using PowerPoint, but I appreciate it is an acquired taste. it is useful for block diagrams too, to help explain the circuit before showing the schematic.

            If you're not into PP, then Visio is an alternative.

             

            Generally I'll just use a conventional schematic too (using EAGLE in my case, but there's plenty of options), and then try to have a detailed photo of the PCB or breadboard too.

             

            EDIT: One more thing, personally I feel high-res helps for everything : ) That block diagram above was drawn six years ago, but since I'd saved it in a high-res, it still looks readable without needing to zoom in heavily, on the more modern super-high-res monitors, despite having drawn the diagram on probably a 1024x768 screen 6 years ago. Just personal taste has changed since then though.. now I'll often use a white background for such things, and thicker lines and a larger font. Not everyone likes large file sizes perhaps, but I have to make a compromise somewhere, and if I have to make that choice then it will be on the side of readability.

            It is really sad seeing valuable books and documents with diagrams that are low-res and unreadable, or hard to follow monochrome photos using halftone dots. I know that was the technology limit with printing at the time, but it is still sad, especially when it is an interesting piece of work and you know it would have been exciting to see the photo in slightly higher-res.

            11 of 11 people found this helpful
            • Re: Documentation of projects
              jw0752

              Hi Brian,

               

              In addition to what I may place in a blog on a project I always make an owners / service manual to go along with each project. I find that even simple projects have a way of becoming difficult to understand if they have been sitting on the shelf for a couple years. The manual provides a progression of schematic revisions and notes on experiments that were necessary to complete the design. I also photograph the project as it is being built and include a gallery of photos in the manual. I have found that I always remember and need pictures that I did not take so don't hesitate to take more than you may need. The manuals are produced in report form as well as being stored on my shop data base. Here is an example of a build and the manual for it. As you can see they are very simple but very helpful should I ever need to service it.

               

               

              I really liked your question as the answers from the other members will provide some good ideas and resources for everyone.

               

              John

              9 of 9 people found this helpful
              • Re: Documentation of projects
                fmilburn

                Hi Brian,

                 

                This is a great topic that should get more attention.  The projects posted on element14 I enjoy most are also good educational sources - often for the author and the reader.  This means the project objectives, design basis, design calculations, appropriate links, and technical underpinnings are usually laid out and described with a "what would I do different next time" at the end.  Documenting the basis of design decision does not get done often enough in my opinion.  A schematic for hardware and code if software is involved are minimal requirements.  Assembly instructions may be necessary for some projects and a user manual as John describes is a great idea.

                 

                Frank

                2 of 2 people found this helpful
                • Re: Documentation of projects
                  Jan Cumps

                  To document concepts and prototypes, I use paper and pencils.

                  I then use a scanner, or phone with Office Lens application, to add it to my documentation.

                  A photo doesn’t give a clear picture but using Lens turns it into a clear readable image.

                  Example:

                   

                   

                  For more permanent exercises, I use KiCad. I put comments on the schematic. When I want to document a selected part of the design, I printscreen the KiCad schematic, paste it in Paint, and erase the components and connections that aren’t relevant.

                  Example:

                  7 of 7 people found this helpful
                  • Re: Documentation of projects
                    andrewj

                    I have captured design notes, Spice models, schematics, calculations, testing data, drill patterns and case layouts.  Basically, anything I think I might need to minimise errors or understand what was done when/if I come back to it later.  Also, in case others are interested.  Makes me sound experienced, but this is just over two or three projects so far.

                     

                    I use Kicad for the schematics - its easy to pick up and feature packed.  You could create the breadboard (actually PCB laid out in BB dimensions) and use the 3D view feature to see the part layouts.  Most, but unfortunately not all parts have a 3D model and you can screen capture the image on different rotations and viewpoints.  Not ideal of course as hookup wire won’t be there so until it was tried I don’t know how well it might work in practice.  I suppose one question worth asking is does it matter if the layout matches what would be done on a breadboard even if the base looks like a PCB?? Other tools I use are Excel for BOMs and calculations, and Omnigraffle (MacOS version of Visio) for layout planning and drill patterns.

                     

                    If you are doing it for others’ use, I always think it worth documenting your thinking as well, particularly if you go down a dead-end or change your mind on something.  The trials and tribulations are as interesting and insightful as providing a fully working, tested solution.

                     

                    Good question.

                    6 of 6 people found this helpful
                    • Re: Documentation of projects
                      sjmill01

                      My modus operandi:

                      • Autodesk Fusion 360 files to gift any 3D printed parts
                      • Autodesk Fusion 360 generated 2D Design Files for cut and assembled parts
                      • Autodesk Eagle for Electrical Schematics.
                      • Code Headers to describe any pin connections when I'm not providing a custom daughter board with wire-to-board connectors
                      • Github to store it all including code
                      • element14 to bind it altogether for the hookup guide/build log with photos and BOMs

                       

                      See ya',

                      Sean

                      7 of 7 people found this helpful
                      • Re: Documentation of projects
                        three-phase

                        My methods mirror much of what has already been said in the other posts.

                         

                        I use KiCad for schematics and PCB layouts. For more electrical biased drawings I use a normal CAD package, TurboCAD, Visio and SmartDraw have all been used over the years.

                         

                        Calculations are generally done in Excel. MathCAD is used for more complex calculations. All the test results for my insulation tester reviews are in Excel and then plotted using the graphing function as required. I also find Excel good for BOMs, but sometimes I use Word for this.

                         

                        Excel BOM Example

                         

                        Having seen what shabaz has created in Power Point, I too have started to use that to produce basic layouts.

                         

                        PowerPoint Example

                         

                        I will either store the project as separate files in one folder on the computer, or if need be I will pull everything into a Word document, to create a more formal manual for it. I then usually index this and create as a PDF as I refer to read documents in a PDF viewer instead of Word.

                         

                        Along with all of the files I have created, I will store manufacturer's data sheets, parts orders, emails and subject information in the same folder, so I try and end up with everything for the project in one location.

                         

                        Project Folder

                         

                        Kind regards.

                        7 of 7 people found this helpful
                        • Re: Documentation of projects
                          DAB

                          I always document projects with a paper notebook.

                          I can write, draw and make notes at will while I am going through the development process.

                          In the end, your documentation is more essential than your initial build. Capturing the decision process is essential to understanding how to do a better project the next build.

                           

                          DAB

                          5 of 5 people found this helpful
                          • Re: Documentation of projects
                            colporteur

                            My go tools tools are Gimp and Inkscape. Both icons are in my favourites on Ubuntu 18.04.

                             

                            GNU Image Manipulation Program (GIMP) is a cross-platform image editor available for GNU/Linux, OS X, Windows and more operating systems. Whether you are a graphic designer, photographer, illustrator, or scientist, GIMP provides you with sophisticated tools to get your job done.

                             

                            Inkscape is professional quality vector graphics software which runs on Windows, Mac OS X and GNU/Linux. It is used by design professionals and hobbyists worldwide, for creating a wide variety of graphics such as illustrations, icons, logos, diagrams, maps and web graphics.

                             

                            Sean

                            1 of 1 people found this helpful