-
User Guides:
Purpose: To provide a comprehensive understanding of the product and its functionalities.
Content: Covers all aspects of a product, including features, settings, and use-case scenarios.
Audience: General users who need a deep dive into the product’s capabilities.
-
Quick-Start Guides:
Purpose: To facilitate immediate usage of the product for a specific task.
Content: Condensed steps for performing key tasks, often in a visual, easy-to-follow format.
Audience: Users who want to start using the product immediately without delving into extensive details.
-
On-boarding Guides:
Purpose: To provide a structured initiation into the product.
Content: Includes tutorials, activities, and checklists for new users.
Audience: New users who need an organized introduction to get comfortable with the product.
-
Administration Guides:
Purpose: To enable admins to manage, monitor, and maintain the system or product.
Content: Instructions on admin-specific functionalities, user management, system settings, and more.
Audience: System administrators or people responsible for maintaining the product at an organizational level.
-
Maintenance Guides:
Purpose: To provide information on maintaining the health and functionality of the product.
Content: Regular maintenance tasks, preventive measures, and best practices.
Audience: Administrators or users who need to ensure long-term functionality of the product.
-
Getting Started Guides:
Purpose: To help new users begin using the basic functionalities quickly.
Content: Introduction to the product, essential settings, and basic tasks.
Audience: New users unfamiliar with the product.
-
Installation Guides:
Purpose: To guide users through the installation process.
Content: Step-by-step instructions for installing the product, often with troubleshooting tips for common issues.
Audience: Users setting up the product for the first time.
-
Configuration Guides:
Purpose: To assist in customizing the product settings according to user needs.
Content: Detailed explanations of different configuration options and how to implement them.
Audience: Advanced users or administrators who need to custom-tailor the product settings.
-
Upgrade Guides:
Purpose: To assist users in transitioning to a newer version of the product.
Content: Steps to follow for a successful upgrade, what’s new, and potential pitfalls to avoid.
Audience: Existing users moving to a more recent version.
