Best Practices Guide
Overview
The Best Practices Guide is a cross-functional, scenario-driven section. The feature documentation (CMDB configuration management, Discovery & Collection, Users & Permissions, etc.) answers "what each module is and how to use it." This section answers "how to combine multiple modules to accomplish a real-world business task."
If you have already read the relevant feature documentation but are still asking "so how exactly do I do this...?", this section is for you.
What This Section Helps You Do
- Cross-module composition: Chain Discovery & Collection, CMDB, Dashboards, User Permissions, and more into a complete workflow.
- Real-world business scenarios: End-to-end walkthroughs based on actual operations needs (e.g., "new data center going live," "building a monitoring dashboard").
- Recommended approaches: Battle-tested configuration combinations validated in real deployments, reducing trial and error.
Scenarios Suited for This Section
| Scenario Type | Example |
|---|---|
| New environment initialization | Bulk onboarding in a new data center; full provisioning flow for a new business line |
| Cross-module composition | Building a business monitoring dashboard with Query Studio + Dashboards |
| Permission modeling | Designing roles / user groups / resource permissions for a new team |
| Troubleshooting | Full-chain investigation when configuration item data is anomalous (Collection → CMDB → Permissions) |
| Platform operations | Handling tenant expiration; platform upgrade playbooks |
| Change impact analysis | Pre-assessment when modifying configuration item types / relationships |
Not suited for this section:
- Single field descriptions → belong in the corresponding feature documentation
- API parameter tables → belong in the API documentation
- Installation and deployment → belong in the "Installation" section
How It Complements the Feature Documentation
Before reading this section, we recommend familiarizing yourself with the relevant modules. Each best-practices guide begins with a Prerequisite Reading list so you can brush up as needed.
| Document Type | Questions Answered | When to Read |
|---|---|---|
| Getting Started | What is the product; core concepts | First encounter with the platform |
| Feature documentation (CMDB, Collection, Permissions, etc.) | Fields, operations, and configuration for each module | Look up as needed when using a specific module |
| Best Practices Guide (this section) | How to combine multiple modules to accomplish a business task | When you are familiar with the modules and need to implement a scenario |
| API documentation | Request / response formats for interfaces | Custom development / automation integration |
Section Roadmap
This section will grow continuously. The following scenarios are planned for the initial rollout (in priority order):
- Bulk onboarding in a new data center (Discovery & Collection + Collection Templates + Tags) — delivered as Spiral Discovery: Expanding Topology Layer by Layer from a Single Entry Point
- Business monitoring dashboard (Query Studio + Dashboards)
- Permission modeling for a new team (Roles + User Groups + Resource Permissions)
- Configuration item change impact analysis (Configuration Item Types + Relationships + Change History)
If you have a specific cross-functional scenario you would like to see covered, please share your feedback with the product team. We will add content based on demand.