myphoner

Employees Handbook

Writing Product Documentation

Our documentation is split into three different areas/types:

Let’s describe the purpose and extend of each of those.

FAQ

The FAQ is mainly intended to people wanting answers to common questions before they sign up. So these are questions that we have had regarding payments and subscription, user management, reliability of the service etc.

However, the FAQ also holds those questions that are frequently asked by customers, such as troubleshooting upload or dialing.

We want to keep FAQ entries short and consice, and preferably to refer to the other documentation where applicable.

The FAQ is located at www.myphoner.com/faq

Getting Started Guide

The Getting Started Guide is where people comes just after signing up. It should convey the basic ideas of myphoner and assist in all the tasks one need to do to start using and getting benefits from myphoner.

It should be written in a how-to style and only include the steps absolutely neccesary to achieve a certain goal (like uploading a list).

Exceptions, advanced usage and complicated procedures should be put in the detailed documentation and referred to by the Getting Started Guide.

The getting started guide is located at www.myphoner.com/getting-started

Currently, we miss guides on the following tasks:

Detailed Documentation

The Detailed Documentation is a complete reference for myphoner. It’s divided by subject, not by task as the Getting Started Guide (e.g. Lead Distribution, Deduplication, Reporting etc.).

The detailed documentation should focus on being complete and correct (this includes explaining underlying algorithms) rather than easy to read.

The detailed documentation is located at www.myphoner.com/docs

Currently, we miss documentaiton on the following subjects: