AAP Guides use two authoring frameworks. Pick the one that matches your content type before you start writing or scoring a draft.
Solution Guide
Solution Guide Best Practices
- Who it is for
- Field teams and solution architects writing partner-focused reference architectures that show how AAP solves a measurable operational problem.
- What it covers
- Nine-section framework: outcome-oriented title, business framing, workflow diagrams, solution walkthrough, validation, and Crawl/Walk/Run maturity path.
- Scoring
- Weighted rubric with category-aware adjustments for AIOps and Network automation Solution Guides. AIOps Use Cases use a lighter rubric row in the same document.
Implementation Guide
Implementation Guide Best Practices
- Who it is for
- Platform owners and senior engineers writing deployment, tuning, and day-2 operations guides for AAP in production.
- What it covers
- Platform-focused framework: architecture decisions, step-by-step walkthroughs, validation with expected output, runbooks, and production readiness.
- Scoring
- Separate rubric weighting architecture clarity, executability, validation, and day-2 readiness over business framing.
Why two rubrics?
Solution guides and implementation guides answer different questions. Scoring them with one rubric either penalizes platform guides for missing partner ROI narratives, or lets solution guides pass without production-grade validation.
| Dimension | Solution Guide | Implementation Guide |
|---|---|---|
| Primary question | Why and what -- the business problem and integrated outcome | How -- reliable platform configuration at scale |
| Reader | IT leaders, architects evaluating a partner integration | Platform owners, SREs deploying and operating AAP |
| Success signal | Measurable operational outcome with partner context | Validated deployment with runbooks and day-2 guidance |
| Rubric emphasis | Business framing, workflow narrative, partner integration depth | Architecture clarity, executability, production and day-2 readiness |
Not sure which type fits? See Guide Types for definitions, tracks, and examples.