Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description:

Product documentation provides detailed information about a product's features, functionality, and usage. This is crucial for supporting customers, sales teams, and internal staff. Centralizing product documentation ensures consistency and up-to-date information.

Examples:

  • User Guides: Step-by-step instructions for installing, configuring, and using the product.

  • Feature Descriptions: Detailed explanations of product features and their benefits.

  • Troubleshooting Steps: Solutions to common problems users might encounter.

How-to Manual:

  1. Create Central Product Documentation:

    • Create a new Confluence page titled "Product Documentation."

    • Add comprehensive details about the product, including user guides, feature descriptions, and troubleshooting steps.

  2. Create Excerpts:

    • Highlight key sections (e.g., "Installation Guide," "Feature Overview") and create excerpts using the "Multiexcerpt" macro.

  3. Categorize Excerpts:

    • Organize excerpts into categories such as "Installation," "Features," "Troubleshooting," and "User Guides."

  4. Embed Excerpts in Customer Support and Sales Pages:

    • Create separate Confluence pages for customer support and sales teams.

    • Use the "Multiexcerpt Include" macro to embed relevant excerpts from the "Product Documentation" page into these pages.

  5. Automatic Updates:

    • Ensure that any updates to the central product documentation automatically update the embedded excerpts on the support and sales pages, providing consistent and up-to-date information to customers and sales teams.