Designing Maintainable Documentation
Since we work almost exclusively with software companies, our technical writers understand the challenges of keeping content updated while software development continues. For new products, this is handled by identifying the stable portions of the software, focusing on those and expanding our focus as additional features come into play. For ongoing maintenance, our technical writers use a variety of strategies. In both cases, the key is to develop and maintain a clear, consistent, appropriate information model for our work. This model provides a schematic view of the types of content and level of detail needed for all variations of documentation involved. It is tailored for the needs of both the user and the development cycle, and is one of the ways in which we can quickly assess the impact of software changes on the documentation.
We’d be happy to discuss your needs in more detail, with no cost or obligation.