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:

    Where we come from in America no longer signifies—it’s where we go, and what we do when we get there, that tells us who we are.
    The irony of the role of women in my business, and in so many other places, too, was that while we began by demanding that we be allowed to mimic the ways of men, we wound up knowing we would have to change those ways. Not only because those ways were not like ours, but because they simply did not work.
    Anna Quindlen (b. 1952)

    Language makes it possible for a child to incorporate his parents’ verbal prohibitions, to make them part of himself....We don’t speak of a conscience yet in the child who is just acquiring language, but we can see very clearly how language plays an indispensable role in the formation of conscience. In fact, the moral achievement of man, the whole complex of factors that go into the organization of conscience is very largely based upon language.
    Selma H. Fraiberg (20th century)

    Theories of child development and guidelines for parents are not cast in stone. They are constantly changing and adapting to new information and new pressures. There is no “right” way, just as there are no magic incantations that will always painlessly resolve a child’s problems.
    Lawrence Kutner (20th century)