docs-impact-architect

Featured

Use this skill when the docs-impact-classifier returns a structural verdict, signalling that the documentation TOC must change to accommodate the PR. Proposes TOC deltas (new pages, moves, merges) and emits new-page outline stubs that the doc-sync panel later fleshes out. Holds the 3-promise narrative (consume / produce / govern) and the persona ramps as hard constraints.

AI & Automation 3,385 stars 300 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 91/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# docs-impact-architect Single responsibility: when the classifier says a PR needs structural docs changes (new page, page move, TOC reshape), design the change and emit: 1. A precise TOC delta (added pages, moved pages, retired pages) 2. New-page outline stubs (slug, title, persona, promise, H2 sections, key examples) 3. The persona-ramp impact (which ramp gains/loses a stop) You are NOT the writer (doc-writer owns prose). You are the **TOC architect**. The CDO will arbitrate whether your proposal lands the 3-promise narrative; you do the first design pass. ## When to invoke The docs-sync orchestrator invokes you ONLY when the classifier returned `verdict: structural`. For `no_change` or `in_place` you don't run. ## Inputs - `structural_proposal` from the classifier (a sketch you refine) - The PR diff (`gh pr diff $PR`) - `.apm/docs-index.yml` (full corpus map) - The PR description (for author-stated intent) ## Step 1: read the corpus map, not the corpus Load `.apm/docs-index.yml` entirely. Inspect `chapters[]`, `pages[]`, `promises[]`. This is your map. You do NOT read the 100+ page corpus unless a specific page is implicated by the classifier's sketch. ## Step 2: classify the structural shape Match the PR's surface change to one of these structural shapes: | Shape | Pattern | Example | |---|---|---| | **NEW CAPABILITY** | A new CLI verb, primitive type, or schema concept the docs have no slot for | `apm pack --format wheel` adds a new package format | | **EXPAN...

Details

Author
microsoft
Repository
microsoft/apm
Created
10 months ago
Last Updated
2 days ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Featured

docs-impact-localizer

Use this skill to translate a classifier's in-place verdict into a precise, page-by-page work plan for the docs-sync panel. Activate after docs-impact-classifier returns verdict in_place; reads the candidate page list, fetches the actual page contents, narrows scope to specific sections within each page, and emits the per-page task brief the panel fans out against.

3,385 Updated 2 days ago
microsoft
AI & Automation Featured

docs-sync

Use this skill whenever a pull request is opened, reopened, or synchronized in microsoft/apm to assess whether and how the documentation corpus must change to stay truthful with the proposed code change. Activate even when the PR title or body says nothing about docs -- the skill must run on every PR to detect silent drift between code and docs. Classifies impact as no-change, in-place edit (one to a few paragraphs), or structural change (new page or TOC reshape), then orchestrates a CDO + doc-writer + python-architect + editorial-owner + growth-hacker loop to produce a patch-ready advisory. Does NOT review code quality, security, or test coverage. Does NOT auto-merge or auto-push doc edits.

3,385 Updated 2 days ago
microsoft
AI & Automation Featured

docs-impact-classifier

Use this skill to classify the documentation impact of a pull request diff, returning one of three verdicts -- no-change, in-place edit, or structural change -- with bounded LLM cost. Activate as a sibling skill of docs-sync; the orchestrator calls this first, before any panel spawn, to keep cost floor at 1 LLM call when no docs work is needed. Reads .apm/docs-index.yml as the corpus map; never reads the full corpus.

3,385 Updated 2 days ago
microsoft