Creating User Documentation for an IP Phone (Windows CE 5.0)
Windows CE 5.0 includes document templates designed specifically for IP 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 CE IP phone solution.
| Type | Description | Template Description and Location |
|---|---|---|
| Quick Start Guide | Explains how to set up the IP phone for initial use and how to begin using the IP 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 file is located in %_WINCEROOT%\Public\Common\SDK\Samples\Quick Start Guide. |
| Help; User's Guide | An in-depth online or printed document that explains how to use all of the functionality in the IP phone.
In many cases, it is appropriate to include both online Help and a printed User's Guide. (Although the content for these documents may be similar, the user reads each type differently and the documentation should be designed appropriately.) |
Windows CE includes IP phone user Help, which is integrated with the Telephony User Interface (TUI).
For more information, see Using and Modifying TUI User Help. |
The following table shows additional suggested types of user documentation. Templates for these types of documentation are not included with the Windows CE IP 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's Guide | Explains how to administer server and other elements of the IP phone solution that are not directly part of the experience of a person using the IP phone.
Note The IP phone solution and Windows CE include functionality that makes administration of IP 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 IP phone is designed and implemented. |
See Also
Developing an IP Phone | Creating End User Documentation for an OS Design
Send Feedback on this topic to the authors