How to Create a Quick Start Guide for a Thin Client

8/27/2008

You can create a Quick Start Guide to improve the out-of-box experience for users of your Windows Embedded CE powered thin client.

For an example template that you can use when you create your Quick Start Guide, see the Microsoft Office Word document in the %_WINCEROOT%\Public\Common\SDK\Samples directory. You must change the example information into information that is specific to your thin client.

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 that you verify the correct Microsoft product names before publishing any documentation. If you have any questions, contact a Microsoft representative.

For general information about how to create a Quick Start Guide with best practices, see Creating a Quick Start Guide for a Device.

Description of a Quick Start Guide for a Thin Client

The following list describes the formatting of the template for a thin client Quick Start Guide.

• Design the template to fold by using 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 side of the guide provides immediate instructions to set up the device and starting to use it.
• The back side of the guide contains useful information beyond what is necessary for initial setup and use.

The template uses Microsoft Office Word paragraph styles and character styles to differentiate information types. The following list shows examples of style formatting.

• Placeholder content is formatted with italic. You must update it as appropriate for your specific thin client implementation.
• Software user interface (UI) elements are formatted with bold in procedures.
• Illustrations are generic examples and must be replaced with images that show the actual thin client.

Consider adding a separate one-page short and concise Quick Reference card with instructions for important user tasks, shortcuts, and useful but hard-to-discover features.

To create a Quick Start Guide for a thin client

1. Read the suggestions in Best Practices for a Quick Start Guide.

2. Open the Quick Start template for a thin client located in the %_WINCEROOT%\Public\Common\SDK\Samples\QuickStartGuide directory, and then save it to a folder on your computer.

3. Change the information that is located on the Start Here page to reflect specific information about your organization and your thin client.

4. Change all references to documentation titles and product names to reflect specific titles and names in your thin client.

5. Update the procedures with information that is specific to your thin client.

6. Replace all illustrations with illustrations that are specific to your thin client.

See Also

Concepts

Creating End-User Documentation for a Thin Client

Other Resources

Developing a Thin Client