what should a software documents contains in it .what should i include.can u just specify

Question

0.00/5 (No votes)

See more:

general

what information i have to include in the documentation.

Posted 4-Apr-12 21:21pm

syedkhaleel

Add a Solution

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

OriginalGriff · Answer 1 · 2012-04-04T21:29:00

Everything.

Ideally, documentation is there to help a new person (or yourself in six months time) come up to speed on the software as fast as possible. Everything that you can provide which will help that should be included.

In the real world, documentation is thrown together at the end of the project by people who don't care about it under serious time pressure from management who want them on a new project NOW.

Personally, I prefer to do it as I go along, when I can. That way I know it is at least relevant.