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 14:54
Read: times


 
#174320 - Proper documentation is part of the task
Responding to: ???'s previous message
Everyone who works commercially should write properly documented code.

All assumptions should be described.
Any requirements when setting up the project (which may possibly need to be redone if switching to a different tool)
Important reasons for design decisions.
How to test different functionality.
Any timing requirements.
...

For evaluation boards, the customer can be seen as a student buying an educational kit. So the teacher must be pedagogical.

But for normal projects, it must be assumed that someone else - possibly not well-versed on the specific hardware and/or compiler - may for some reason have to take over the project.

At that time, the compiler may no longer be possible to buy. Or maybe Microsoft have made it impossible to run the tools. Or the tools may have been so much upgraded that they can't process the old project files. Or the compiler may have been updated to a language standard that no longer uses specific compiler extensions.

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