Developing effective user documentation: a human factors approach
Developing effective user documentation: a human factors approach
Human factors and typography for more readable programs
Human factors and typography for more readable programs
Advanced programming in the UNIX environment
Advanced programming in the UNIX environment
Design patterns: elements of reusable object-oriented software
Design patterns: elements of reusable object-oriented software
Design and implementation aspects of an experimental C++ programming environment
Software—Practice & Experience
A generative development-process pattern language
Pattern languages of program design
Pattern-oriented software architecture: a system of patterns
Pattern-oriented software architecture: a system of patterns
Software maintenance—an industrial experience
Journal of Software Maintenance: Research and Practice
Object-Oriented Software Construction
Object-Oriented Software Construction
| Hi-index | 0.00 |
When designing a component, the developer holds certain usage scenarios in mind. But this is not enough. If customers do not understand the component's purpose and how its developer expected it to be used, they will misuse it. Good documentation is the primary means of communication between a software component's creator and its users, providing insight into design intent, use cases, and potential problems. The author provides four examples that show how patterns can provide guidance on documentation content, structure, and presentation.