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

Back to Subject List

Old thread has been locked -- no new posts accepted in this thread
Oliver Sedlacek
04/03/06 02:34
Read: 402 times
Uk


 
#113543 - Two categories
Responding to: Jan Waclawek's previous message
I've been thinking about this for some time now. I've come to the conclusion that documentation falls into two categories.

Structured
The requirements, specifications, quality plans, test strategies, schematics, sources and test results are formal documents which should be kept in a structured system under revision control (I'm a big fan of revision control software, even for one man projects). Most big organisations will have a system in place, and it's pretty much mandatory if you work to quality standards like ISO9001.

Unstructured
There is a bunch more information which is important but which doesn't fit in to a structured system. Most engineers use a lab book or project book or day book. This is much better than nothing, but I think that electronic versions have something to offer. I'm starting to use a wiki to capture information which I think is important, and I like the idea of project blog.

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