Email: Password: Remember Me | Create Account (Free)

Back to Subject List

Old thread has been locked -- no new posts accepted in this thread
???
03/19/10 15:36
Read: times


 
Msg Score: +1
 +1 Informative
#174326 - GUI Settings Documentation
Responding to: ???'s previous message
I use the tool called Meazure to take screen shots of all key and essential settings, file lists, and dialog boxes and then paste the result into a Word document. Following that the Word document is printed to PDF and saved away with the project archive. Any other essential product information is also saved as PDF as well including diagrams I may have prepared in AutoCad or Visio, spreadsheets from Excel or Helper Tools built in VB6 or C.

Some IDEs will save a bunch of their info in some type of text or XML file. If so I will make a note of this in the Word document and may include important extracts of those files as well.

The Word file, due to ability to save items from pictures, objects and textual also facilitates documenting additional items such as:

- target product photos
- target product screen shots
- product schematics or schematic snippetts
- source code snippetts such as error message summaries
- product run time data outputs such as log output or calibration data dump
- product connector pinnings
- test cable definitions
- debug pod connections, usage diagrams or photos
- product code release notes and version tracking summary
- and maybe even some of the product block diagrams is applicable.

I save the Word DOC file primarily for use as a path to the next version of the document.

Meazure can be had for free from: http://www.cthing.com/Meazure.asp

Michael Karas



List of 65 messages in thread
TopicAuthorDate
Whinge about Eval and Quickstart kits            01/01/70 00:00      
   Most time probably spent with other work tasks            01/01/70 00:00      
   while I basically agree, some comments            01/01/70 00:00      
      Missing the point (ed)            01/01/70 00:00      
      What I want..            01/01/70 00:00      
         What I want..            01/01/70 00:00      
            It's a non-starter ... What if I need 5.9908 MHz?            01/01/70 00:00      
               re: What if I need 5.9908 MHz?            01/01/70 00:00      
                  I think Richard was being generic there...            01/01/70 00:00      
      Here's what I'd want ...            01/01/70 00:00      
   Unfortunately agree            01/01/70 00:00      
      Proper documentation is part of the task            01/01/70 00:00      
         pedagogical            01/01/70 00:00      
         Fundamental problem with GUIs            01/01/70 00:00      
            GUI Settings Documentation            01/01/70 00:00      
               Screenshots            01/01/70 00:00      
   only today            01/01/70 00:00      
      That's the reason there's so much junk            01/01/70 00:00      
   as the little girl pointed out...            01/01/70 00:00      
   Previously, on 8052.com...            01/01/70 00:00      
   who's evaluating who?            01/01/70 00:00      
   Changing the installation location.            01/01/70 00:00      
      filenames with spaces in it            01/01/70 00:00      
         Exactly            01/01/70 00:00      
         Bizarre bugs.            01/01/70 00:00      
      Spaces            01/01/70 00:00      
         "My Documents" directory            01/01/70 00:00      
            May and may...            01/01/70 00:00      
   Xilinx            01/01/70 00:00      
      Or, perhaps worse, none ...            01/01/70 00:00      
   What is the purpose?            01/01/70 00:00      
      The way I see it            01/01/70 00:00      
         Disagree (mostly)            01/01/70 00:00      
            well            01/01/70 00:00      
               quite so            01/01/70 00:00      
                  Easy to get a customer to move to a competitor            01/01/70 00:00      
                     The problem stems from...            01/01/70 00:00      
                        Misses in communication and assumptions alas common            01/01/70 00:00      
                           'first demo' to a customer ...            01/01/70 00:00      
                              That's because            01/01/70 00:00      
               not only that ...            01/01/70 00:00      
         see above ...            01/01/70 00:00      
      I've looked at a lot of "eval" boards ...            01/01/70 00:00      
         app notes            01/01/70 00:00      
            a CD with their demo boards            01/01/70 00:00      
            what good would that do?            01/01/70 00:00      
               mark this on your calendar ... Erik and I agree!            01/01/70 00:00      
               project files            01/01/70 00:00      
                  how?            01/01/70 00:00      
                  run != tested            01/01/70 00:00      
                  That's exactly the wrong attitude            01/01/70 00:00      
                     wrong or not, makes sense            01/01/70 00:00      
                        But            01/01/70 00:00      
                        What goes around comes around            01/01/70 00:00      
                           I think something got lost            01/01/70 00:00      
                              Yes MANUFACTURERS            01/01/70 00:00      
                                 Per, I do not disagree            01/01/70 00:00      
                                    no synergy?            01/01/70 00:00      
                                       au contraire            01/01/70 00:00      
                                       the key is in UNDERSTANDING the example            01/01/70 00:00      
                                    deviate vs derivative            01/01/70 00:00      
                                       SILabs            01/01/70 00:00      
                                          deviates            01/01/70 00:00      
                        Portable within company portfolio            01/01/70 00:00      
   Devkits            01/01/70 00:00      

Back to Subject List