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

Back to Subject List

Old thread has been locked -- no new posts accepted in this thread
???
01/20/04 14:10
Read: times


 
#62963 - RE: Good Documentation
Responding to: ???'s previous message
One thing I picked up when working totally outside the embedded world was to make a folder with datasheets for every component in the system. This is fairly simple (you need the datsheets to design) and saves a bunch of time during debugging.

As for actual documentation:
C is not self documenting. The amazing thing is that if you structure your program right and comment it right you have all documentation needed except for the schematic. I can not emphasize enough that if a program require documentation outside the code it is not structured!

Erik

List of 29 messages in thread
TopicAuthorDate
Good Documentation            01/01/70 00:00      
   RE: Good Documentation            01/01/70 00:00      
      RE: Good Documentation            01/01/70 00:00      
         RE: Good Documentation            01/01/70 00:00      
         RE: Good Documentation            01/01/70 00:00      
            RE: Good Documentation            01/01/70 00:00      
               RE: Good Documentation            01/01/70 00:00      
               RE: Good Documentation            01/01/70 00:00      
   RE: Good Documentation            01/01/70 00:00      
   RE: Good Documentation, Andy, Pravin            01/01/70 00:00      
      RE: Good Documentation, Andy, Pravin            01/01/70 00:00      
         RE: Good Documentation - clarification            01/01/70 00:00      
            RE: Good Documentation - clarification            01/01/70 00:00      
               RE: Good Documentation - clarification            01/01/70 00:00      
                  RE: Good Documentation - clarification            01/01/70 00:00      
                     RE: Good Documentation - clarification            01/01/70 00:00      
                        RE: Good Documentation - clarification            01/01/70 00:00      
                           RE: Good Documentation - clarification            01/01/70 00:00      
                              RE: Good Documentation - clarification            01/01/70 00:00      
                                 RE: Good Documentation - clarification            01/01/70 00:00      
                                 RE: Good Documentation - clarification            01/01/70 00:00      
                                    RE: Good Documentation - clarification            01/01/70 00:00      
                              RE: Abdul            01/01/70 00:00      
            RE: Good Documentation - Pravin            01/01/70 00:00      
   RE: Good Documentation            01/01/70 00:00      
      RE: Doctors and documentation            01/01/70 00:00      
         RE: raghu            01/01/70 00:00      
            RE: raghu            01/01/70 00:00      
            RE: raghu            01/01/70 00:00      

Back to Subject List