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:

    Such is the role of poetry. It unveils, in the strict sense of the word. It lays bare, under a light which shakes off torpor, the surprising things which surround us and which our senses record mechanically.
    Jean Cocteau (1889–1963)

    Women’s battle for financial equality has barely been joined, much less won. Society still traditionally assigns to woman the role of money-handler rather than money-maker, and our assigned specialty is far more likely to be home economics than financial economics.
    Paula Nelson (b. 1945)

    The development of civilization and industry in general has always shown itself so active in the destruction of forests that everything that has been done for their conservation and production is completely insignificant in comparison.
    Karl Marx (1818–1883)