Software documentation samples
These samples are re-published with permission.
Arcos HTML help 
arcos_help.zip, 122 KB, expands to 445 KB.
Arcos is a code-generation tool which is used to create database-driven web sites. It is produced by Kusala Web Developments (www.kusala.com).
The documentation is designed for web developers, and is highly technical. The help files are written in pure HTML, so they can be used on both Unix and Windows platforms. We did not use any script or browser-specific enhancements. Read the Kusala case study for more information.
Visual PCL/2 Help 
vispcl.chm, 89 KB. (You may need two additional files for Windows 95 and Windows 98 systems.)
Visual PCL/2 (www.visual.co.uk/viewer.html) is a LaserJet PCL print file viewer for Windows that is produced by Visual Software.
The software is simple to use, and this small Microsoft compiled HTML help (CHM) consists of just a few topics. Technical issues are addressed by referring users to the Visual Software web site (various pages open seamlessly from within the CHM help). Read the Visual case study for more information.
Getting Started with Optrax GettingStartedwithOptrax.zip, 421 KB, expands to 643 KB Word document.
Optrax is a multi-user scheduling application produced by New Vision Software.
This award-winning user guide was designed to help users get started with the software as quickly as possible. It covers all the main features of the software, but it doesn't go into great depth. If users need additional information, context-sensitive online help is available.
Getting Started with SDLX 
GettingStartedwithSDLX.pdf, 444 KB.
SDLX online help SDLXolh.zip, 835 KB, expands to 4.06 MB (25 files).
SDLX is a translation memory software application produced by SDL International (www.sdl.com).
This award winning documentation is a classic example of how a user guide and online help work together. The user guide briefly covers the main features of the software, but it doesn't go into great depth. Comprehensive reference information is available in the context-sensitive online help (WinHelp format). Read the SDL case study for more information.
The WinHelp is modular — when viewing it as stand-alone help, open sdlx.hlp to access all the other modules.
Sample Lotus Notes 5 database TechScribeSampleHelp5.zip, 485 KB, expands to 1.20 MB Notes 5 database.
This technical writing sample demonstrates some of the features that you can expect in a Notes help database. In practice, context-sensitive help could be created, so that when users request help from your Domino application, the appropriate topic is displayed.
We don't have permission to show any of the Notes databases that we have created, so this one was produced for demonstration purposes. The content is a subset of the TechScribe web site.
TechScribe Introduction to Microsoft Windows 
IntroWindows.doc, 886 KB.
This self-paced tutorial was designed primarily for users who were migrating from dumb terminals to PCs in the Windows 95 environment. It also had to cater for people who had never used a PC.
The content is much simpler than the average user guide; it shows you what you can expect in a tutorial-style document.
RSS feed