USER GUIDES AND OPERATING MANUALS

User Guides and Operating Manuals can often be similar to courseware and tutorials with the exception of not being interactive. It adds to the challenge to make these documents work both as a learning tool and a resource document. CLICK ON IMAGES TO OPEN DOCUMENTS.

SYSTEMS DOCUMENTATION

Internal System Documentation may not seem very interesting but if you're writing them they can be. I'm inquisitive to a fault and love mysteries so finding all about how a system works can be interesting, especially when they are elegantly constructed.

I am disappointed to only have one of the Systems Requirements documents left from Transamerica Assurance Corporation (Direct Billing System). I am grateful for the opportunity they gave me to learn the process of documenting a system for programming. The Visio diagramming inside this document lays out the position of the application within its environment and then the final third of the document uses captured and annotated screen graphics to clearly describe how the interviewed users wanted their screens to look. My interest in graphics allowed me to describe my user interviews in actual screens, pleasing both users and developers. CLICK TO OPEN DOCUMENTS.

direct billing system documentation authored by larry dunlap technical writer
Another nice little application in the suite that automated downloaded payments into the system with full reconciliation.
pay capture system documentation authored by larry dunlap technical writing
Operator's Manual for Transamerica Assurance's Pay Capture system.
Direct Billing Requirements document authored by larry dunlap technical writer
This application was built as an add-on to the suite to handle a sticky problem with automatic payments that were rejected for some reason.
tape reject clearing system documentation authored by larry dunlap technical writer
Direct Billing was one of my favorite applications. This SRD describes the reversioning process from users to developers. Despite its bland name, DB was the conductor of all the activities in the TAC application suite, working with time and decision making in clever and elegant ways.

DIAGRAMMING

As a picture is worth a thousand words, for the documentarian diagrams are a valuable tool in expressing complex relationships and not just technical data. They are also useful to designers or developers to help clarify concepts during the development process. Here are a few diagrams demonstrating some of these wider uses. Diagrams at their best can be deceptively simple by clearly describing a complex process.

Note that the documents in the SYSTEMS DOCUMENTATION panel, feature a lot of process DIAGRAMING, especially the DIRECT BILLING - REQUIREMENTS, DIRECT BILLING - SYSTEM DOCUMENT, and the PAY CAPTURE SYSTEM DOCUMENTATION documents.

Tabel Refresh Diagram by larry dunlap systems analyst
ODDS system logic diagram for how the cable industry data feeds automatically refresh the network's affiliate cable systems data at a given interval.
Deployment diagram by larry dunlap systems analyst
A topological diagram of the ODDS data system.
enterprise diagram by larry dunlap systems design
A big picture view of the Odyssey (Hallmark) Channel Enterprise.
systems analysis logic diagrams by larry dunlap systems analyst
Several logic diagrams from the Direct Bill Server application for TAC.
imperial wars world state diagram by larry dunlap system design
A look at the various states of a world from an early version of the Imperial Wars design document.
test plan progress diagram by larrydunlap courseware development
A diagram built to illustrate the path of a successful Y2K test proof for in-house applications as part of workshop to create standardized test plans.

Note that the documents in the SYSTEMS DOCUMENTATION panel, feature DIAGRAMING, especially the DIRECT BILLING - REQUIREMENTS, DIRECT BILLING - SYSTEM DOCUMENT, and the PAY CAPTURE SYSTEM DOCUMENTATION.

ONLINE HELP SYSTEMS

I was introduced to RoboHelp while consulting for Transamerica where I used it to produce two online help systems for the company's intranet. One for the Customer Service help desk, following the documentation in the Customer Service User Guide, and the other for use with the CASE (Computer Assisted Sales and Enrollment) legacy system. The Imperial Wars game online help system is the only current online help available for show.

imperial wars online help system authored by larry dunlap game design

CLICK ON THE LOGO to view the online help system for the players of the multi-player strategy role-playing game Imperial Wars. This is a live application.