New York Tech Writer

Technical Documentation Outsourcing Services

Products

Manuals

Manuals are key to system understanding and use. Users request them, Management demands them and Auditors & Regulators require them. Though they may never be used, they must be produced.

User Manual

User Manuals describe actions: how to do something, organized from the User's perspective and includes operating procedures.

Reference Manual

Reference Manuals describe things: what the system does, organized from the System's perspective.

Miscellaneous Manuals

A comprehensive Documentation Plan includes a number of additional manuals including:

Installation Manual
Maintenance Manual;
Service Manual.

Guides

Quick Start Guides, User Guides and Quick Reference Cards help users overcome their initial fears, often the greatest obstacle to system use, and provide initial application data to get them up and running.

Nothing is more frustrating for a new user than a new system with new concepts and new terminology and no idea of where to start

Users instinctively reject cumbersome and unwieldy user or reference manuals when looking to fix a problem.

Document Types

The types of documentation we produce is Illustrated below.

Manuals	Procedures	Guides	Flowcharts
Illustrations for example purposes only. Confidentiality agreements prohibit us from displaying document contents. No personal information or intellectual property is made available to outside parties. Samples available on request.