Providing User Documentation

  • Article

Applies To: Windows 7, Windows Server 2003, Windows Server 2003 R2, Windows Server 2003 with SP1, Windows Server 2003 with SP2, Windows Server 2008, Windows Server 2008 Foundation, Windows Server 2008 R2, Windows Server 2012, Windows Vista

In addition to Providing Custom Connection Manager Help (.chm) with your documentation, you can incorporate other types of user documentation in your connection profile. You can also develop and incorporate your own user documentation. Start by reviewing the information provided:

  • Sample procedures, included later in this topic:

    • Setting up Connection Manager

    • Establishing a connection

    • Removing your service

To reduce your customer-support effort, make sure your setup and usage instructions clearly and completely guide users through both the setup of Connection Manager and connection to your service.

To include user documentation in your connection profile, you can specify the files as additional files (in the Additional Files pane of the CMAK wizard). For more information, see Including Additional Files.

Note

Information included as additional documentation is not available to users until after the installation of your connection profile. You may want to include some of the information (such as installation procedures) in a readme file to accompany your connection profile, in a form that can be accessed by users before installation.

User procedures

You should provide user documentation to help your users install, run, and remove (if necessary) Connection Manager and your profile. You can customize the following procedures and put them in a readme file or other user documentation.

Throughout these user procedures, you should substitute the name of your connection profile for each occurrence of ProfileFileName, regardless of the context in which it is used.

The following procedures contain glossary entries and links to a Web site. Depending on the format and support files you provide with your documentation, these may not work as implemented here. Change these as appropriate for your deliverables.

When you run the CMAK wizard to build the connection profile, specify the file names of all user documentation that you want incorporated in the connection profile (to be available after the connection profile is installed) as additional files.

Setting up Connection Manager

Instruct your users to perform the following procedure for setting up Connection Manager.

To set up Connection Manager

  1. Use the appropriate method to find the ProfileFileName file:

    • If you received the Connection Manager program on removable media:

      1. Insert it in the appropriate drive.

      2. Use Windows Explorer to find the file.

    • If you downloaded the Connection Manager program from the Internet or a private network, browse to your download folder.

  2. Double-click ProfileFileName.exe.

  3. After installation has finished, double-click the icon on your desktop to start the connection. If prompted to install additional components, click OK.

Establishing a connection

Have users follow these steps to connect to your service:

To establish a connection

  1. Perform one of the following steps:

    • If you are running Windows 7 or Windows Server 2008 R2:

      1. Click the Network icon in the task bar notification area.

      2. Click ProfileFileName and then click Connect.

    • If you are running Windows Vista or Windows Server 2008:

      1. Click the Network icon in the task bar notification area, and then click Connect to a network.

      2. Click ProfileFileName, and then click Connect.

    • If you are running Windows XP, Windows Server 2003, or Windows 2000:

      • On the desktop, double-click the ProfileFileName icon.

  2. Type your user name, password, and if required, your logon domain.

  3. (Include this step if you are documenting a dial-up connection.) If you are using Connection Manager to connect for the first time, click Properties, click Phone Book, and then select a phone number from the list of access numbers, or type the phone number, and then click OK twice.

  4. (Include this step if you are documenting a VPN connection.) If you are using Connection Manager to connect for the first time, click Properties, select the VPN tab, select a VPN server from the list of available servers, and then click OK.

  5. Click Connect to establish the connection.

    When you connect, the service might update your settings if new or changed phone book or server information is available.

Note

For help with establishing a connection or with troubleshooting, click Help in the Connection Manager logon dialog box.

Removing your service

Have users follow these steps if they want to remove your service.

Note

This procedure removes only the connection profile. The Connection Manager software remains on the user's computer, as users may require it for other profiles on the computer.

To remove your service

  • If you are running Windows 7 or Windows Server 2008 R2:

    1. Right-click the Network icon in the task bar notification area, and then click Open Network and Sharing Center.

    2. On the left side of the page, click Change adapter settings.

    3. Right-click ProfileFileName, and then click Delete.

    4. On the confirmation dialog box, click Yes.

  • If you are running Windows Vista or Windows Server 2008:

    1. Click the Network icon in the task bar notification area, and then click Network and Sharing Center.

    2. In the Tasks list, click Manage network connections.

    3. Right-click ProfileFileName, and then click Delete.

    4. On the confirmation dialog box, click Yes.

  • If you are running Windows XP, Windows Server 2003, or Windows 2000:

    1. Right-click the Network icon in the task bar notification area, and then click Open Network Connections.

    2. Right-click ProfileFileName, and then click Delete.

    3. On the confirmation dialog box, click Yes.

Additional references