Documentation Options
While we often work with clients on customized services to better fit their needs, the following is a list of common options for companies looking to improve their product documentation and training:
Definition: Instructions for programmers on how to develop applications communicating with an Application Programming Interface.
Example: Integrator’s Guide
An excerpt from API for a VoiceXML application.
Definition: Flash demonstrations for product use.
Definition: A document summarizing the performance and other characteristics of a component, a sub-system or software in sufficient detail to be used by a design engineer to design the component into a system.
Definition: Documentation that defines a new product’s design based on its functionality.
Example: Functional Requirements Specifications
Excerpt from a POS terminal FRS describing a Sale Transaction.
Definition: How-to videos, usually for instructions on how to use a specific product.
Example: BackOfficeBay6 (Broadband | Dial-up)
Sales/Training demo for a back office electronic check processing application.
Definition: Interactive, online instruction materials and information vital to learning the procedures of a product or institution.
Definition: Detailed file format definitions which include, for example, the name, length, attributes and valid values.
Example: Message Specification
Specification of message formats for a POS device to communicate with a payment processor for check processing.
Definition: A form of user assistance that provides topic-oriented, procedural or reference information delivered through computer software.
Definition: Written form of standard operating procedures and policies.
Definition: A comprehensive description of a product and instructions on how to use it.
Example: Preparing the TWIN tt for Dry-Vacuuming
Instructions for setting up the AquaFilter and attaching the dry suction hose in a consumer vacuum manual.
Definition: A concise description of a process to reference when carrying out that specific process.
Example: Talento Quick Reference Guide
A card describing operating instructions for a POS terminal.
Definition: System-wide overview of the processes, applications, etc. which operate in a software system.
Definition: Written procedure information and instructions.
Definition: A technical communication document intended to give assistance to people using a particular system.
Example: Company LEARN Administrator’s Guide
Guide for administrators of a learning management system.
Definition: A report or guide that addresses problems and how to solve them used to educate readers and help people make decisions.
Example: Arresting Fraud with Automated Notifications
White paper for an automated fraud alert system.
