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:

    But however the forms of family life have changed and the number expanded, the role of the family has remained constant and it continues to be the major institution through which children pass en route to adulthood.
    Bernice Weissbourd (20th century)

    The trouble is that the expression ‘material thing’ is functioning already, from the very beginning, simply as a foil for ‘sense-datum’; it is not here given, and is never given, any other role to play, and apart from this consideration it would surely never have occurred to anybody to try to represent as some single kind of things the things which the ordinary man says that he ‘perceives.’
    —J.L. (John Langshaw)

    Creativity seems to emerge from multiple experiences, coupled with a well-supported development of personal resources, including a sense of freedom to venture beyond the known.
    Loris Malaguzzi (20th century)