# Important Information about the Smartphone OEM End User Documentation Kit

© 2003 Microsoft Corporation. All rights reserved.

Release Information
Smartphone OEM End User Documentation Kit Components
Recommended Documentation Deliverables
Start Here Recommendations
Logo and software licensing

## Release information

Instructions about how to download the documentation kit and general announcements will be published on the Windows Mobile Device Maker Portal Web site at https://msftmobile.com. Please note that you will need a Partners extranet user account and password to access this Web site, which you may need to request from the primary contact in your company.

The documentation kit will be available via the JetStream File Transfer Servers, as follows:

US Server: https://usjs.partners.extranet.microsoft.com/us20/mdd/common/dist/

Asia Server: https://eajs.partners.extranet.microsoft.com/ea20/mdd/

Please note that you will need to use the JetStream client application (not an Internet browser) and a Partners extranet user account and password to access the JetStream File Transfer Server. If you do not have an account, please ask the person who manages group membership in your organization to add an account for you, or send mail to mddadmin@microsoft.com.

If you have any questions about the Windows Mobile End User Documentation Kit, or if you would like to receive e-mail communications about updates, future plans for the Windows Mobile End User Documentation Kit, and so on, please send mail to medeudoc@microsoft.com.

back to top

## Smartphone OEM End User Documentation Kit Components

- Start Here Card Recommendations
  These recommendations include suggested content, formatting, and layout decisions that you may want to consider for the creation of a Start Here card that ships in the box with your mobile-device product, intended to help customers quickly and easily set up and start using their new device.
- User's Guide
  These files provide "how to" and conceptual content you can use to create a User's Guide document, intended to provide customers with comprehensive information about the features and functionality of your product. You can find these files in the root folder of the documentation kit. Included in the documentation are notes for OEMs. To view these notes, select the Hidden text option in Microsoft Word, found on the View tab under Tools>Options. All art referenced in these files is included in the art folder. Note that both paragraph and character styles are used in the documentation to differentiate information types, for example, UI elements are formatted bold in procedures. To reference styles, view Styles and Formatting in Word. All images within the User’s Guide document are linked in the Word document. View Field Codes in Word to see the names of the specific file. (Note: A screen shot utility is included in the Smartphone Adaptation Kit that you can use to create screenshots of your actual mobile-device product. If you have any questions about the screenshot utility or Adaptation Kit, please ask your Microsoft Program Manager contact.)

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.

back to top

## Recommended Documentation Deliverables

Microsoft recommends that you create the following documentation deliverables to support customers with using their new mobile device, and to help reduce the number of support calls:

- Start Here
  The Start Here document should be a printed foldout, included in the box with your mobile-device product, intended to help users set up their new device, synchronize information, and learn about basic tasks and functionality.
- Quick Reference
  The Quick Reference document should be a very small, printed, wallet-sized document that is included in the box with your mobile-device product, that users can carry with them while they familiarize themselves with their new device. This should include short, to-the-point instructions for the most important user tasks, useful shortcuts, and useful but hard-to-discover features.
- User's Guide
  The User's Guide should be a printed or online document, containing comprehensive information about your mobile-device product, such as setup information, "how-to" and conceptual information for mobile-device features and functionality, and pointers to where users can find additional help and support.
- Web-based documentation
  Consider making your User's Guide available to your customers on your corporate Web site (either as a .PDF or as an online Help system), accessible via a PC or on your mobile-device product using Internet Explorer. You can then provide additional, up-to-date information, including troubleshooters and FAQ information, to address support issues.

back to top

## Start Here Recommendations

The Start Here Best Practices information focuses on optimizing the out-of-box experience for mobile-device users, based on feedback from our partners and usability studies conducted at Microsoft. This research clearly shows that placing a Start Here document in the box will help improve the out-of-box experience for users and will reduce the number of support calls.

- Include a Start Here document in the box

  Including a Start Here document with your product is a critical component of the out-of-box experience. A well-written and designed Start Here document not only helps users set up their device with ease, it also serves as a first impression of the product, which can increase customer confidence and satisfaction, and can help reduce the number of support calls due to setup issues.

- Make the Start Here document the first thing users see

  If the Start Here document is the first thing users see when they open the box, they will most likely follow the steps included in the document and successfully set up their mobile device. If users don't see the Start Here document when they first open the box, they will more likely begin to explore the device without any guidance, which often results in a support call.

- Use illustrations whenever possible

  Consider providing clear illustrations for various setup tasks, such as connecting the parts, charging the battery, and so on. Illustrations help users feel more confident about setting up and handling their new device, and help to make the setup instructions more clear.

- Keep information brief and concise

  The Start Here document should explain how to set up the device in brief, easy-to-follow steps. Our research shows that adding more information than absolutely necessary for initial setup will drive users away from using the Start Here document.

- Create a clean page layout

  Use a clear call to action on the cover page, such as "Start Here."

  Use one page per major task, and clearly label each page with a task-based heading, using bold text.

  Number the mandatory tasks that need to be done in order. Users are more likely to follow steps with big bold numbers that clearly stand out.

- Present the Start Here content as a foldout

  A foldout that shows all getting started tasks at one glance is the preferable format for the Start Here content. Users will most likely use it and go through all tasks.

  A foldout format works better than a booklet, and clearly shows users where they are in the setup process.

  Consider using the front side of the foldout for all basic setup tasks and an illustration of the device with callouts, while using the back of the Start Here foldout for additional information, such as a list of status indicators, where users can get additional help, and so on.

- Organize the information according to user tasks

  All required setup tasks should be listed first, and should be numbered as easy-to-follow steps, while non-setup tasks (to showcase key features of the device, for example), do not need to be numbered.

  Following is a list of the types of information you should consider including in your Start Here document.

  Start Here

  The title page should include only the document title, with a clear call to action, such as "Start Here." You may also want to reflect your product branding on this page through color usage, background image, logo, and so on.

  What's in the box?

  Show all essential components that ship in the box and label them so the user can recognize them. Using illustrations will make it easier for the user to recognize the components. Include this information on the front side of the foldout, along with the required setup tasks.

  Getting to know your [mobile-device name]

  Provide an illustration of the device with callouts for all hardware elements as well as key elements of the Today screen, and include basic interaction tips if appropriate. Consider placing this illustration near required setup steps so that users can refer to it as they familiarize themselves with their new device.

  Get your [mobile-device name] ready to go

  Use illustrations to show how to insert the Subscriber Identity Module (SIM) and battery. Make sure that the illustration shows the device connected to power but not connected to a USB port.

  Be specific about details, such as charging the battery, and how long it will take.

  Turn on your [mobile-device name] and make a phone call [for phone-enabled devices only]

  Many users are eager to try out their device, but be sure to guide them through all setup steps first before guiding them through key tasks.

  Synchronize Outlook

  Because a very high percentage of users will synchronize their Outlook data with their device, this should be part of the numbered setup tasks.

  Add a separate note about the different ways of accessing e-mail because this tends to be confusing for users and causes them to call support.

  Set up an e-mail account or use Web-based e-mail

  Consider setting up a Web site where you provide relevant information about the major Internet service providers (ISPs).

  For setting up an existing account on the device, add a separate note about how to get server type, incoming and outgoing mail server names, user name, and password to reduce the number of support calls.

  Securing your [mobile-device name]

  Be sure to promote information about how users can lock their device, and/or secure data stored on the device.

  Take a picture and send it via e-mail [for camera-enabled devices only]

  If your device has a built-in camera, users will very likely want to try it out right away. Add sufficient information to guide users through taking a picture and sending it to someone via e-mail.

  Status indicators

  Status indicators need explanation until users become familiar with them.

  Entering text, numbers, and symbols

  Information about entering characters is important for some of the getting-started tasks on the front of the Start Here document.

  Customizing your [mobile-device name]

  Our research shows that users want to have information about how to customize and personalize their device.

  Making and receiving calls [for phone-enabled devices only]

  Consider including more in-depth information about key features, such as creating speed dials or customizing the ring tone.

  Need Help?

  Consider addressing known support issues to reduce the number of support calls.

  Consider including a link to the primary Web site where customers should go for support on the Web. This Web site should include troubleshooters or FAQ content that is based on feedback from support calls. A Web site is easier to keep up to date than a printed document.

  Consider including a pointer to other helpful Web sites that may also be helpful to customers, such as http://www.microsoft.com/windowsmobile or http://www.pocketpcthoughts.com.

  Register your [mobile-device name]

  Consider adding registration information on the last page of the Start Here document.

back to top

## Logo and software licensing

To display the Designed for Windows Mobile™ logo on your device hardware, packaging, documentation or marketing materials you must first complete a logo license agreement for each product meeting the requirements for the logo. For usage guidelines, refer to the Microsoft OEM Embedded license agreement.

Please remember that this logo is required for any products that ship after March 2004.

Steps for completing a license agreement:

1. Register

   You will first need to register with the Microsoft OEM Embedded Web site using a .NET Passport and your login credentials, so that you can complete an online logo license agreement at https://microsoft.embeddedoem.com.

2. Submit a license agreement

   Once you have access to the Microsoft OEM Embedded Web site, you can complete and submit a Designed for Windows Mobile logo license agreement at https://microsoft.embeddedoem.com/logooverview.asp.

3. Download artwork

   Once your agreement is approved, you can access the online Designed for Windows Mobile Logo Library and download logo artwork. You may also grant read-only access to up to three additional users to view your license agreement(s) and download the artwork.

back to top