Why we do this is for "Planning before we code" and one another point is to "help the newcomers in the team". We are a team of 5-8 members. We do have API documentation and Readme included with our projects. Writing a solution document once is not a hard task. But problem facing is, It is time-consuming and hard to maintain every change we make later stages in our source-code into a separate solution document we keep. So is it worth writing a solution document?

  • 3
    Different development teams have very different ideas of what does and does not belong into a documentation. Could you elaborate a bit about what your practices are? Also, how large is your team and how knowledgeable are the developers in both software development methodology and domain knowledge? – Philipp Oct 27 '18 at 10:54

Its depends on why you are creating the document.

  1. To show the customer what to expect and act as a specification for the project.

  2. To act as an instruction manual for the software that new starters can refer to.

  3. To keep track of the requirements of the software over time, so that new requests don't remove seldom used requirements by mistake etc.

I would say that a solution doc is pretty good for 1. But people have stopped bothering with 2 all together and use unit/acceptance tests for 3.

If you find you are creating documentation because "we need documentation!" but no-one ever reads it. Then just stop writing it.

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.