Software Documentation Suite
Context
Rulestream ETO is an engineer-to-order software that integrates with CAD, ERP, and other PLM software. As Rulestream’s first and only Technical Writer, the goal of this role was to create documentation suite for the entire product and maintain legacy documents.
Problem
When I started at Siemens (Rulestream), the legacy documents were the only ones to refer and which weren't updated for almost a decade. A lot of customers were sometimes unaware of various features been rolled out. The only way they could find this out was by contacting technical support.
It was essential to let customers know frequently what we were working on and how it would enhance their user experience.
Contribution
I was assigned to manage the entire suite of documentation, which involved documenting install guide, system requirements, release notes, release notes compendium, product integration guides, UI/UX guide, user guides, and reference documentation.
I worked with our developers, testers, and management team to keep track of new features, enhancements and tweaks across our products.
Over the course of 6 months, I managed to update the entire product suite. So here are a couple of examples -
Impact
- Customers were able to instantly find out about product releases which helped marketing teams convert or upgrade customers.
- Reduced the number of support requests and allowed support teams to focus on more complex issues.
- Enabled users to understand the underlying technology, make informed decisions, and provide meaningful feedback to the development team for future improvements.