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:

    The traditional American husband and father had the responsibilities—and the privileges—of playing the role of primary provider. Sharing that role is not easy. To yield exclusive access to the role is to surrender some of the potential for fulfilling the hero fantasy—a fantasy that appeals to us all. The loss is far from trivial.
    Faye J. Crosby (20th century)

    Nothing is ever simple. What do you do when you discover you like parts of the role you’re trying to escape?
    Marilyn French (b. 1929)

    I’ve always been impressed by the different paths babies take in their physical development on the way to walking. It’s rare to see a behavior that starts out with such wide natural variation, yet becomes so uniform after only a few months.
    Lawrence Kutner (20th century)