Inisoft’s software documentation was scattered across many Microsoft Word documents, was sometimes out of date and was often rambling, resulting in a poor experience for users.
I implemented a new documentation strategy for Inisoft centred around the use of MadCap Flare for publishing Inisoft’s documentation both online and in PDFs via single sourcing.
In the online documentation I was of course able to introduce search, which is so important for users. At the same time I introduced the concept of “every page is page one”.
This mantra acknowledges that users can land on any page of your documentation first and so cannot be expected to be familiar with any other pages. Every page, therefore, needs to provide sufficient context to the user to help them solve their problem.