Quick Start Guide Sections (Windows CE 5.0)
The following table shows an example of sections to present in a Quick Start Guide.
| Title | Description |
|---|---|
| Start Here | Provide a clear start page that contains the title, "Start Here", the product name, and your company name. |
| What's in the Box? | Show essential components that ship in the box.
Consider labeling the hardware directly so that the user can match the hardware to the names and illustrations in the documentation. For example, attach a label to the power cord that directly corresponds to the call out for the cord in the illustration. |
| Prepare Your <Device> | Use illustrations to show how to connect the hardware. In the text, be specific about details. If connections should be made in a particular order, ensure that this is shown in your illustration. For example, your illustration might show a device that is connected to power but not yet connected to a computer. |
| Configure the <Device> | Provide information that guides the user through configuring the device, such as through a set-up wizard. |
| Getting to Know Your <device> | To make it easy for users to familiarize themselves with the device, include an image that identifies all of the hardware.
You can also describe key elements of the Welcome screen and provide information for basic, initial, interaction. |
| Status Indicators | Provide pictures and descriptions of any status indicators on the device. |
| Making Your <Device> More Secure | Describe the steps that the user can take to improve security. |
| Customizing the <Device> | Provide information about user-configurable settings. |
| Need Help? Troubleshooting | Provide brief help for known support issues.
Because a Web site is easier to keep current than printed documentation, consider including the address of a Web site you have created based on feedback from support calls. Consider including a troubleshooter or frequently asked questions (FAQ) on this site. |
| Registering Your <Device> with <Your Company> | Provide instructions for registering the device. |
| What's Next? | Point out basic and important tasks. Base the tasks you highlight on marketing considerations and special features of your device.
When you point to a user's guide, be specific and refer to the section and page where the task is described. Provide Web addresses to sources of information, including product support. |
You can see examples of Quick Start Guides in the Quick Start templates. These templates are Microsoft Word files (.doc) that are located in the %_WINCEROOT%\Public\Common\SDK\Samples\QuickStartGuide directory.
See Also
Creating a Quick Start Guide for a Device | Creating a Quick Start Guide for a Thin Client
Send Feedback on this topic to the authors