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:

    What is charm then? The free giving of a grace, the spending of something given by nature in her role of spendthrift ... something extra, superfluous, unnecessary, essentially a power thrown away.
    Doris Lessing (b. 1919)

    The most puzzling thing about TV is the steady advance of the sponsor across the line that has always separated news from promotion, entertainment from merchandising. The advertiser has assumed the role of originator, and the performer has gradually been eased into the role of peddler.
    —E.B. (Elwyn Brooks)

    The proper aim of education is to promote significant learning. Significant learning entails development. Development means successively asking broader and deeper questions of the relationship between oneself and the world. This is as true for first graders as graduate students, for fledging artists as graying accountants.
    Laurent A. Daloz (20th century)