Tuesday, April 5, 2011

PROGRAM DOCUMENTATION

Program Documentation is :
  • a kind of documentation that gives a comprehensive procedural description of a program.
  • It shows as how the software is written.
  • Describes what exactly a program does by mentioning about the requirements of the input data & the effect of performing a programming task.
  • The instruction manual for a programming language like Java @ for understanding a word processor can come out in the scope of program documentation.
  • Description languages used are informal & to make easy for the end-user.
  • The contents should be concise so the person who reads it doesn't have to spend too much time to find what they are looking for.
  • End-user they are the user-friendly language about the software.
  • In this step, all the prior documentation is reviewed, finalized & distributed.
  • Documentation is important for people who may be involved with the program in the future, they are users, operators & programmers.
  • Developer documentation usually consists of tools that will simplify any development task.







Citations :
http://www.blurtit.com/q986115.html
http://www.literateprogramming.com/documentation.pdf