0

My appspot projects are growing and I'm making an SDD ("system design document") and an RAD ("requirements analysis document") for every larger project I deliver (currently 2 and 2 others are also growing.)

Am I doing the right thing? I follow the structure for the documents as mentioned in the book Object-Oriented Software Engineering by Bernd Bruegge and Allen H. Dutoit.

Thanks

  • 1
    What objective are you trying to accomplish by generating these documents? Are you distributing it to customers or other developers? – Jesse Oct 10 '11 at 6:18
  • 1
    Maybe a question for programmers.stackexchange.com? – Tiago Cardoso Dec 10 '11 at 1:12
2

you are doing the right thing when:

  • your colleagues read the documents you wrote and find it useful
  • reuse the knowledge written done in the upcoming/next projects
  • customer asked for it
  • you are paid for it - this is your full time job
  • customer support finds it useful

you are doing the wrong thing when:

  • create documentation because a book said so
  • you are only one who contributes and cares

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.