A Two-Person Inspection Method to Improve Programming Productivity
IEEE Transactions on Software Engineering
The psychology of computer programming (silver anniversary ed.)
The psychology of computer programming (silver anniversary ed.)
Extreme programming explained: embrace change
Extreme programming explained: embrace change
Documentation for software engineers: what is needed to aid system understanding?
SIGDOC '01 Proceedings of the 19th annual international conference on Computer documentation
Pair Programming Illuminated
Handbook of Walkthroughs, Inspections, and Technical Reviews: Evaluating Programs, Projects, and Products
Reverse Engineering and Design Recovery: A Taxonomy
IEEE Software
Domain-retargetable reverse engineering
Domain-retargetable reverse engineering
Domain-retargetable reverse engineering
Domain-retargetable reverse engineering
The reverse engineering notebook
The reverse engineering notebook
Designing UML diagrams for technical documentation
Proceedings of the 21st annual international conference on Documentation
Optimizing IT process management
ACM SIGSOFT Software Engineering Notes
| Hi-index | 0.00 |
Most program documentation is written by developers for developers. This often results in documentation that is less than satisfactory in terms of quality, relevance, and longevity of information to developers who will be responsible for subsequent enhancements to the product. This paper outlines an approach to producing effective program documentation by connecting technical communicators and technical developers in a pair-wise manner. This approach is modeled on the development methodology advocated by eXtreme Programming (XP). Programmers who adopt XP work in pairs, and thus are in constant communication with one another. By pairing a technical communicator with a technical developer, many of the same benefits can be gained. Rather than eschewing program documentation, the paired communicator and developer instead produce high-quality documentation during the development process, with little extra effort, resulting in a more maintainable software application. The paper also describes some recent experiences in pairing a senior person and a junior person in communicator and developer roles to enhance program documentation of a long-lived and popular research application.