Challenge:  Maintain accurate, up-to-date technical information for a system.

Method: Technical documentation of a system, the final step in many development efforts, is often postponed to accommodate new priorities.  The result is a largely undocumented system with little information existing outside the heads of team members.  Consequently, when a new team member joins, the learning curve is extended and if a team member leaves, critical information goes too.  "Rediscovery" of the system becomes a regular part of the development process, as there is no definitive source for technical information. 

I work with managers and development teams to identify the types of documentation needed based on the scope and complexity of the system, accepted best practices, and the needs and available resources of the organization. The documentation effort may include functional specifications as well as technical documentation.  With the need identified, I review existing documents (if any) and explore the system itself, cataloging the functionality and analyzing the structure and technologies used. At the same time, I develop a list of questions so that I can take a targeted approach to interviewing subject matter experts (SMEs).  All the information becomes part of one or more documents containing key information about the system.

Result: Teams can efficiently transition members, reducing ramp-up time and minimizing information loss.  The organization can easily identify and catalog products developed and technologies used.