Documentation samples
The documentation samples on this page are published with permission. The documentation samples on this page are old, because TechScribe is not permitted to show other newer documentation samples.
Getting Started with SDLX
SDLX online help (25 files, WinHelp format. The WinHelp is modular. Open sdlx.hlp to access the other modules.)
SDLX is a translation memory system.
This award-winning documentation is a good example of how a user guide and online help work together. The user guide helps people with the important features of the software, but it does not give details. Full reference information is in the context-sensitive help. For more information, read the SDL case study.
Visual PCL/2 HelpVisual PCL/2 is a LaserJet PCL print file viewer for Windows.
The software is simple. The compiled HTML Help has only five topics. For technical problems, users refer to the Visual Software website. The website pages open in the compiled HTML Help. For more information, read the Visual Software case study.
Optrax is software for scheduling.
This award-winning user guide helps users to get started with the software as quickly as possible. The user guide helps people with the important features of the software, but it does not give details. Full reference information is in the context-sensitive help.
Arcos is a code-generation tool that is used to create database-driven websites.
The Arcos technical documentation is for website developers. The help files are written in HTML. For more information, read the Kusala case study.
Technical literature
Marketing e-mail (before and after example)
Marketing brochure (before and after example)
TechScribe's primary skill is technical writing. To find copywriters who specialise in the software industry, refer to 'Marketing communications for software companies'.
RSS feed