Software documentation samples
These samples are published with permission.
Arcos HTML help 
arcos-help.zip, 122 KB, expands to 445 KB.
Arcos is a code-generation tool that is used to create database-driven websites. It is produced by Kusala Web Developments.
The documentation is for website developers, and is highly technical. The help files are written in HTML, and therefore, they can be used on both UNIX and Windows. We did not use script or browser-specific enhancements. For more information, read the Kusala case study.
Visual PCL/2 Help 
vispcl.chm, 89 KB. (Possibly, you need two other 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 compiled HTML Help contains only five topics. For technical problems, users are referred to the Visual Software website. Web pages open in the help. For more information, read the Visual Software case study.
Getting Started with Optrax 
GettingStartedwithOptrax.pdf, 654 KB.
Optrax is a multi-user scheduling application produced by New Vision Software.
This award-winning user guide helps users to get started with the software as quickly as possible. The user guide covers all the important features of the software, but it does not go into detail. If users need more information, context-sensitive online help is available.
Getting Started with SDLX GettingStartedwithSDLX.pdf, 467 KB.
SDLX online help SDLXolh.zip, 835 KB, expands to 4.06 MB (25 files).
SDLX is a translation memory system that is produced by SDL International (www.sdl.com).
This award winning documentation is a good example of how a user guide and online help work together. The user guide covers all the important features of the software, but it does not go into detail. Full reference information is in the context-sensitive online help (WinHelp format). For more information, read the SDL case study.
The WinHelp is modular. When you view the 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 can be created, so that when users request help from your Domino application, the applicable topic is displayed.
We do not have permission to show the Notes databases that we created. Therefore, we created this demonstration database.
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 be suitable for people who had never used a PC.
The content is much simpler than the average user guide, and it shows you what you can expect in a tutorial-style document.
RSS feed