|
| This Article | ||
| ||
| Share | ||
| Bibliographic References | ||
| Add to: | ||
 Digg  Furl  Spurl  Blink  Simpy  Google  Del.icio.us  Y!MyWeb | ||
| Search | ||
| ||
Using Patterns To Create Component Documentation
March/April 1998 (vol. 15 no. 2)
pp. 84-92
| ASCII Text | x | ||
| Jeffrey Kotula, "Using Patterns To Create Component Documentation," IEEE Software, vol. 15, no. 2, pp. 84-92, March/April, 1998. | |||
| BibTex | x | ||
| @article{ 10.1109/52.663791, author = {Jeffrey Kotula}, title = {Using Patterns To Create Component Documentation}, journal ={IEEE Software}, volume = {15}, number = {2}, issn = {0740-7459}, year = {1998}, pages = {84-92}, doi = {http://doi.ieeecomputersociety.org/10.1109/52.663791}, publisher = {IEEE Computer Society}, address = {Los Alamitos, CA, USA}, } | |||
| RefWorks Procite/RefMan/Endnote | x | ||
| TY - MGZN JO - IEEE Software TI - Using Patterns To Create Component Documentation IS - 2 SN - 0740-7459 SP84 EP92 EPD - 84-92 A1 - Jeffrey Kotula, PY - 1998 VL - 15 JA - IEEE Software ER - | |||
DOI Bookmark: http://doi.ieeecomputersociety.org/10.1109/52.663791
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.
Citation:
Jeffrey Kotula, "Using Patterns To Create Component Documentation," IEEE Software, vol. 15, no. 2, pp. 84-92, March-April 1998, doi:10.1109/52.663791
Usage of this product signifies your acceptance of the Terms of Use.