NextAxiom · Documentation Rescue
Modernizing an aging Help system through reusable content architecture
The Help system had grown around a highly configurable platform. Shared widgets and properties appeared across products and workflows, but the documentation architecture made that common information difficult to maintain.
The challenge
What needed to change
Years of documentation debt had produced duplication, inconsistent terminology, centralized reference pages, and gaps around major capabilities such as forms and workflows. Updating a single piece of information often meant finding and changing it in many places.
The approach
Building a better operating model
- Assessed the existing Help system to identify duplication, missing coverage, and structural maintenance risks.
- Designed a complex, snippet-based content architecture in which shared controls and properties could be authored once and reused wherever they appeared.
- Created 100+ reusable snippets, most reused across multiple locations throughout the Help system.
- Expanded Help coverage by documenting previously undocumented features and improving the accuracy of existing content.
- Established the first GitLab repositories for documentation and introduced version control into the workflow.
The result
What the work made possible
- Reduced repeated content and the risk of inconsistent updates.
- Made shared product behavior easier for customers to find in context.
- Created a maintainable foundation for multiple outputs and product variants.
- Changed the documentation model from page-by-page repair to system-level improvement.