Software

Ask something
Discussion Locked

documentation

0 helpful
7 replies

by cherry_deeps

Closed to new repliesThis discussion is closed. It stays readable, but it takes no new replies.
What is the importance of documentation in software development?

7 replies

by john_wills

1. The user needs information on use of the software; you know this because you yourself use software to write software.
2. The next programmer(maybe you) needs information on the purpose and structure of each part of the software, and the code maynot be enough.
3. The installer needs to know where the various parts of the package are and how they relate so that he can install correctly for the user.

by thechas

By "software development" I assume that you mean, what is the value of documenting the code as you generate it.

One word "DEBUG"!!!!

If there are any problems with the code, debug will take 1/10th the time for well documented code as oppossed to un-documented code.

Remember, no one has as good a memory as they think they do. 6 months after the project is complete, it will take you a whole lot longer than you think to remember what you did when you wrote the code.

Chas

by wordworker

Some prima donna developers don't like to document for the same reason they don't use turn signals. "Why should I signal? I know where I'm going." Any developer who doesn't document code with comments shouldn't be in the business.

This discussion is closed to new replies.