Software Documentation - Role of Documentation in Software Development

Role of Documentation in Software Development

Documentation is an important part of software engineering. Types of documentation include:

  1. Requirements - Statements that identify attributes, capabilities, characteristics, or qualities of a system. This is the foundation for what shall be or has been implemented.
  2. Architecture/Design - Overview of software. Includes relations to an environment and construction principles to be used in design of software components.
  3. Technical - Documentation of code, algorithms, interfaces, and APIs.
  4. End User - Manuals for the end-user, system administrators and support staff.
  5. Marketing - How to market the product and analysis of the market demand.

Read more about this topic:  Software Documentation

Famous quotes containing the words role of, role and/or development:

    A famous theatrical actress
    Played best in the role of malefactress.
    Yet her home-life was pure
    Except, to be sure,
    A scandal or two just for practice.
    Anonymous.

    The Declaration [of Independence] was not a protest against government, but against the excess of government. It prescribed the proper role of government, to secure the rights of individuals and to effect their safety and happiness. In modern society, no individual can do this alone. So government is not a necessary evil but a necessary good.
    Gerald R. Ford (b. 1913)

    ... work is only part of a man’s life; play, family, church, individual and group contacts, educational opportunities, the intelligent exercise of citizenship, all play a part in a well-rounded life. Workers are men and women with potentialities for mental and spiritual development as well as for physical health. We are paying the price today of having too long sidestepped all that this means to the mental, moral, and spiritual health of our nation.
    Mary Barnett Gilson (1877–?)