Vanadis Crawford
ABSTRACT
In today's software environment, more and more products must be installed and configured in concert with one another. Unfortunately, most software is developed product-by-product and the approach to information development is in alignment with the individual development projects. In the end, a user may have to have as many as 20 publications open and 7 help systems up to understand how to implement the overall solution for his or her installation. This paper will discuss the need for cross-product, solutions-oriented documentation, the costs, benefits, and pitfalls of this type of documentation, and some ideas of how this type of documentation can be implemented.
- http://www.redbooks.ibm.com/Google Scholar
- http://publib.boulder.ibm.com/infocenter/iseries/v5r3/ic2924/index.htmGoogle Scholar
Index Terms
- Solutions documentation
Recommendations
Code Documentation
The basic principles of good code documentation include the avoidance of repetition, the coexistence of code and its documentation, the documentation of all artifacts, and a preference for clear code and automated processes to explanatory documentation. ...
Documentation for software engineers: what is needed to aid system understanding?
SIGDOC '01: Proceedings of the 19th annual international conference on Computer documentationSoftware engineers rely on program documentation as an aid in understanding the functional nature, high-level design, and implementation details of complex applications. However, no one really knows what types of documentation are truly useful to ...
Agile Documentation, Anyone?
Software developers are notorious for skimping on design documentation, often eschewing it altogether. This trend has led to claims that it is merely an impediment in the fast-paced and highly pliable world of software development—a useless vestige of ...
Comments