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

Back to Subject List

Old thread has been locked -- no new posts accepted in this thread
Erik Malund
03/10/06 07:36
Read: 456 times
Mt Airy, Nc
USA


 
#111903 - too late and totally wrong
Responding to: Vignesh Prasad's previous message
Do you document as soon as you finish a module in a project, or after completely finishing a project? In other words, what are the practices you follow for documentation purposes?
the most important "document" is the one you write before you write one single line of code. This "document" describes why, what and how.

I know very few that use Hurley before they grab Kochan and if you do not grab Hurley first, your profesdsional life will be slower and more troubled.

As to "documentation" as usually referred to my "rules" are
1) no documentation outside the source code except the user manual.
2) lots of documentation in the source code
3) all documentation in the source code as close to what they document as possible.


Erik

OH, by the way

Hurley: "Logic"
Kochan: "Progarmming in ANSI C"



List of 24 messages in thread
TopicAuthorDate
How do you manage Documentation?      Vignesh Prasad      03/10/06 06:04      
   As soon as you finish??      Andy Neil      03/10/06 07:13      
      User Manual      Vignesh Prasad      03/10/06 10:48      
         it all is very simple      Erik Malund      03/10/06 10:56      
   too late and totally wrong      Erik Malund      03/10/06 07:36      
      you have an easy life won't you      Jan Waclawek      03/10/06 08:40      
         Of course, you only have enough informat      Erik Malund      03/10/06 09:12      
            more on the above, the beauty of the hoo      Erik Malund      03/13/06 06:51      
               in C?      Jan Waclawek      03/13/06 07:51      
                  please do not accuse me of unnatural act      Erik Malund      03/13/06 08:02      
         Design Info      Ian Bell      03/11/06 07:13      
            viewpoint      Jan Waclawek      03/12/06 13:09      
               General Principles      Ian Bell      03/12/06 13:38      
                  the clients...      Jan Waclawek      03/12/06 14:00      
                     Client Variety      Ian Bell      03/14/06 05:26      
                     It's like I said last month ...      Richard Erlacher      04/02/06 18:25      
                  Great      Vignesh Prasad      04/01/06 00:31      
                     I, J OK      Ian Bell      04/02/06 15:10      
                        Repetition      Vignesh Prasad      04/03/06 10:40      
                           My old DOS based suite...      David Smith      04/03/06 11:17      
               Two categories      Oliver Sedlacek      04/03/06 02:34      
                  MIL498      Mahmood Elnasser      04/03/06 13:35      
   write the documentation first      Richard Erlacher      03/11/06 11:50      
      Good points..      Vignesh Prasad      03/12/06 10:05      

Back to Subject List