Many software systems are not properly documented, which makes it extremely difficult for a new developer to pick up where the last one left off. Undocumented or poorly documented code can lead to over-dependence on a single developer, inefficient staff transitions, and expensive production delays.
Our documentation reviews determine whether or not a system's documentation is complete, accurate, and up-to-date. We then make recommendations for areas of improvement. This service includes review of the following types of documentation:
Data Model & Dictionary
This documentation describes the contents of a database in whatever format those contents are stored (e.g., a list of its tables and fields). It might contain a "dictionary" that explains what data type each field is, the semantic (business) meaning of the fields, and examples of values in these fields.
Development Environment Setup Instructions
These are step-by-step instructions that a software developer would need to perform in order to set up their PC (or server) to work on the system's source code. Very often these instructions need to change over time.
These instructions are for anyone attempting to install the software system somewhere. They need to be followed every time the system's source code is changed and rolled out. Ideally, deployments are fully automated. But if that's not the case, detailed instructions for a configuration manager are required