Role of Documentation in Software Development
Documentation is an important part of software engineering. Types of documentation include:
- Requirements - Statements that identify attributes, capabilities, characteristics, or qualities of a system. This is the foundation for what shall be or has been implemented.
- Architecture/Design - Overview of software. Includes relations to an environment and construction principles to be used in design of software components.
- Technical - Documentation of code, algorithms, interfaces, and APIs.
- End User - Manuals for the end-user, system administrators and support staff.
- 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)
“Today, only a fool would offer herself as the singular role model for the Good Mother. Most of us know not to tempt the fates. The moment I felt sure I had everything under control would invariably be the moment right before the principal called to report that one of my sons had just driven somebody’s motorcycle through the high school gymnasium.”
—Mary Kay Blakely (20th century)
“... work is only part of a man’s life; play, family, church, individual and group contacts, educational opportunities, the intelligent exercise of citizenship, all play a part in a well-rounded life. Workers are men and women with potentialities for mental and spiritual development as well as for physical health. We are paying the price today of having too long sidestepped all that this means to the mental, moral, and spiritual health of our nation.”
—Mary Barnett Gilson (1877–?)