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

Back to Subject List

Old thread has been locked -- no new posts accepted in this thread
Richard Erlacher
03/11/06 11:50
Read: 437 times
Denver, Co

#111992 - write the documentation first
Responding to: Vignesh Prasad's previous message
It sounds as though you've fallen into the trap that gets most programmers. Software and firmware have to be testable. Testing is not a process of seeing whether it compiles, and then seeing whether it "does" something. Testing is a process of taking a piece of hardware/firmware/software, and subjecting it to hostile events as well as normal conditions, and verifying that it behaves as was intended. The intention of the designer is the goal that the coder must meet in order to succeed in fulfilling his role.

The designer must precisely specify what the code must do as well as when and how and under which conditions it must do it. He must also specify how the system behaves under both normal and abnormal operating conditions.

The coder must ensure that all the designer's specified requirements are met. He must not add anything, and he must not omit anything. The tester must ensure that the designer's specifications are met under ALL presumed operating conditions. Failure modes must be documented and consistent with the designer's spec's as well. Any failures that fall outside the predicted behaviors must be documented, fed back to the designer, and resolved.

Failures won't even be recognized if documentation in clearly written form doesn't exist.

I've had more than one client tell me that the design and documentation takes 99% of the effort, the debugging, 0.9%, and the coding takes the remaining .1%.

Testing is a separate process undertaken only after the work is essentially complete.


List of 24 messages in thread
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