Creating a Quick Start Guide for a Gateway (Windows CE 5.0)
You can create a Quick Start Guide to improve the out-of-box experience for your customer.
A template that you can use when creating your Quick Start Guide is a Microsoft Word document located in the %_WINCEROOT%\Public\Common\SDK\Samples\Quickstartguide directory. You must change the example information to information that is specific to your Gateway device.
Important Microsoft assumes no liability for the technical accuracy of your documentation. Microsoft will not perform technical reviews or provide support in producing your documentation.
Make sure to verify the correct Microsoft product name before publishing any documentation. If you have any questions, contact your Microsoft representative.
General information about creating a Quick Start Guide, including best practices, is not repeated in this section. For general information, see Creating a Quick Start Guide for a Device.
Gateway Quick Start Guide Description
The following list shows the formatting of the Gateway Quick Start Guide template:
- The template is designed to be folded accordion style. When unfolded, there will be a front side and a back side of the guide, with a fold along each page transition.
- The front of the guide provides immediate instructions for setting up the device and to begin using it.
- The back of the guide contains useful information other than what is needed for initial set up and use.
Microsoft Word paragraph and character styles are used in the template to differentiate information types. The following list shows examples of formatting:
- Place-holder content is formatted italic. You must update it as appropriate for your specific Gateway.
- Software user interface elements are formatted bold in procedures.
- Illustrations are generic examples and must be replaced with images that show the actual Gateway.
Consider adding a separate, very small Quick Start Reference Card with short, to-the-point instructions for the most important user tasks, useful shortcuts, and useful but hard-to-discover features.
To create a Quick Start Guide for a Gateway device
- Read the suggestions in the section Best Practices for a Quick Start Guide.
- Open the desired Quick Start template from the %_WINCEROOT%\Public\Common\SDK\Samples\Quickstartguide directory, and then save it to a logical place on your computer.
- Change the information on the Start Here page to be specific to your organization and device.
- Change all references to documentation titles and product names to be specific to your device.
- Update the procedures with information that is specific to your device.
- Replace all illustrations with illustrations that are specific to your device.
See Also
Creating End User Documentation for a Gateway | Developing a Gateway
Send Feedback on this topic to the authors