/
Product documentation

Product documentation

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.

Related content

Marketing Materials and Sales Documents
Marketing Materials and Sales Documents
More like this
Knowledge Management and FAQ Pages
Knowledge Management and FAQ Pages
More like this
Training and Development Materials
Training and Development Materials
More like this
Quality Management Handbook
Quality Management Handbook
More like this