Creating User Documentation for a VoIP Phone

8/27/2008

Windows Embedded CE 6.0 includes document templates designed specifically for Voice over IP (VoIP) phones. You can use these templates as starting points or models for your own user documentation.

Important

Microsoft assumes no liability for the technical accuracy of your documentation. Microsoft will not perform technical reviews or provide documentation support when you produce your documentation. Make sure to verify the correct Microsoft product name before publishing any documentation. If you have any questions, contact your Microsoft representative.

The following table shows some suggested types of user documentation. Templates for these types of documentation are included with the Windows Embedded CE VoIP phone solution.

Type	Description	Template Description and Location
Quick Start guide	Explains how to set up the VoIP phone for initial use and how to begin using the VoIP phone. For general tips about creating a Quick Start Guide, see Creating a Quick Start Guide for a Device.	This Word template is contained in the file named Quick Start guide for IP Phone.doc, which is located in %_WINCEROOT%\Public\Common\SDK\Samples\Quick Start Guide.
Help documentation, user guide	An in-depth online or printed document that explains how to use all of the functionality in the VoIP phone. In many cases, it is appropriate to include both online Help and a printed user guide. (Although the content for these documents may be similar, the user reads each type differently and the documentation should be designed appropriately.)	Windows Embedded CE includes VoIP phone user Help, which is integrated within the VoIP Phone Suite. For more information, please see Using and Modifying IP Phone Suite User Help.

The following table shows additional suggested types of user documentation. Templates for these types of documentation are not included with the Windows Embedded CE VoIP phone solution.

Type	Description
Quick Start Reference Card	Contains short, to-the-point instructions for the most important user tasks, useful shortcuts, and useful but hard-to-discover features.
Administrator Guide	Explains how to administer server and other elements of the VoIP phone solution that are not directly part of the experience of a person using the VoIP phone. Note: The VoIP phone solution and Windows Embedded CE include functionality that makes administration of VoIP phones easy, like provisioning support, opportunities for management of the software on the device (image update), and so on. This functionality varies greatly depending on how the VoIP phone is designed and implemented.

See Also

Concepts

Creating End-User Documentation for an OS Design

Other Resources

Developing a VoIP Phone