One of my early assignments as a consultant involved documenting a complex IRA management system. Because a large number of developers working on this system were also consultants, project managers feared losing that knowledge as consultants rolled off the project and also needed a quick way to bring new developers up to speed.
A large part of my work on the project involved documenting the various components that comprised this system and how they worked together. This sample describes the reporting engine for this system and ensured knowledge transfer as well as saving billing hours by giving new developers the ability to build their own groundwork without needing full-time assistance from more experienced consultants.
Developed in Word. As I only have hardcopies of this document, I’ve scanned this sample, so please forgive the quality.