Case studies
Reaching new markets through clear documentation. Triangle extended the functionality of the InfoGenesis point of sale software onto hand-held terminals. To turn this into a commercial off-the-shelf product, Triangle needed clear documentation for their resellers and for staff managers at customer sites. TechScribe designed the documentation; Triangle has minimised its support costs, and can roll out the software to new markets using resellers.
Technical editing.
MachineWorks had a set of comprehensive documentation that needed to be updated for a new release of its software. The majority of the work involved editing source material that the software developers wrote.
Improving user instructions. Users need clear and unambiguous instructions to be able to perform their tasks effectively. This case study compares instructions that a client supplied with new instructions that TechScribe wrote. It highlights problems in the original, and it explains the reasoning behind the new instructions.
Integrating tutorial help with developer-written reference material. This case study shows how TechScribe integrated reference material that was written by software developers with tutorial-style help. When new functions are developed by the software development team, they simply write the technical notes within their development environment, and then use a script to create the reference help.
Moving from printed to online help. This case study shows how Visual Software retained control of the content of its technical documentation, whilst also significantly reducing the documentation that was presented to most of its users. TechScribe reduced a 47-page user guide to 5 topics. Links from the online help to the Visual Software web site allowed users easy access to technical help.
Good documentation reduces costs and increases sales. This case study shows how SDL International benefited from TechScribe documentation. We significantly reduced the number of calls to their help desk, and the documentation was instrumental in generating new sales.
RSS feed