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

Back to Subject List

Old thread has been locked -- no new posts accepted in this thread
???
03/12/06 20:38
Read: times


 
#112024 - General Principles
Responding to: ???'s previous message
Jan Waclawek said:
There are different veiwpoints to the topic as there are big differences in the circumstances of each project of each of us.

My task is usually more complicated than what Ian described, the clients are far less knowledgeable and far more demanding then usually. The v0.1 cannot be a mockup but it has to be the full application; however, there are substantial changes down to the skeleton even in v3.2, as the client finds out what he wants finally. And, it has to fulfill various contradictory requirements of several involved parties...

So there is no universal approach to documentation as there is no universal approach to electronic design either.

Whilst every project and every client is different, I am convinced there are general principles for both design and documentation that can be applied to any project. The only differences will be the emphasis each receives as dictated by the project specifics.

1. Start with a Product Specification. You need to write down right from the start the product functional and performance requirements. If nothing else, in Jan's case that defines what version 0.1 is supposed to be. This document can be subject to changes reflected in its issues number and the changes can be clearly defined in the document itself.

2. Divide the project into stages. Each stage must have defined goals. Each stage should have a project plan which defines what needs to be done to achieve the stated goals, how long it will take to achieve, the resources needed and any inputs needed from the client. Give the client a copy so he knows what to expect and when and also what his responsibilities are.

3. Use a Day Book for each project. Write down all your technical thoughts, calculations, circuit diagrams, code fragments, test results etc in it. Never hand it to the client. The day book is a Design Document.

4. Write a Design Specification. This is the design response to the Product Specification. It says how the design will achieve the functional and performance requirements.

5. Write a Test Specification. This says how you are going to verify that the design meets the requirements.

6. Document the details of the design as they occur. Much of this will already exist in the Day Book but with software this means, as Erik says, in the code itself.

I have never met a client that did not appreciate a professional approach as outlined above.

I still use a Day Book even though I am now retired.

Ian


List of 24 messages in thread
TopicAuthorDate
How do you manage Documentation?            01/01/70 00:00      
   As soon as you finish??            01/01/70 00:00      
      User Manual            01/01/70 00:00      
         it all is very simple            01/01/70 00:00      
   too late and totally wrong            01/01/70 00:00      
      you have an easy life won't you            01/01/70 00:00      
         Of course, you only have enough informat            01/01/70 00:00      
            more on the above, the beauty of the hoo            01/01/70 00:00      
               in C?            01/01/70 00:00      
                  please do not accuse me of unnatural act            01/01/70 00:00      
         Design Info            01/01/70 00:00      
            viewpoint            01/01/70 00:00      
               General Principles            01/01/70 00:00      
                  the clients...            01/01/70 00:00      
                     Client Variety            01/01/70 00:00      
                     It's like I said last month ...            01/01/70 00:00      
                  Great            01/01/70 00:00      
                     I, J OK            01/01/70 00:00      
                        Repetition            01/01/70 00:00      
                           My old DOS based suite...            01/01/70 00:00      
               Two categories            01/01/70 00:00      
                  MIL498            01/01/70 00:00      
   write the documentation first            01/01/70 00:00      
      Good points..            01/01/70 00:00      

Back to Subject List