跳到正文
cccskills
免费在 GitHub 公开

docs-impact-architect

Plan documentation structure changes for a pull request, a proposed code change. Produce page outlines and a precise list of additions, moves, and retirements while checking reader learning paths, links, and redirects.

中文简介正在准备中。当前显示英语简介。

原文查看原文说明

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.

查看安装方法

适用场景

  • Plan documentation pages for a new feature
  • Split or merge pages as concepts change
  • Review learning paths for different readers
  • Plan redirects for retired pages

包含的文件(1)

  • SKILL.md6.0 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

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:

ShapePatternExample
NEW CAPABILITYA new CLI verb, primitive type, or schema concept the docs have no slot forapm pack --format wheel adds a new package format
EXPANDED CAPABILITYAn existing concept grows in scope and the current page can't hold itapm install gains a registry-proxy mode that needs its own sub-page
DEPRECATED CAPABILITYA removed CLI verb, flag, or concept; existing pages need to be retired or rewrittenA flag is removed; tutorial pages still teach it
CONCEPT SPLITOne concept becomes two distinct concepts; one page becomes twoapm audit splits into audit and audit ci
CONCEPT MERGETwo concepts unify; two pages should become oneapm pack and apm bundle merge into one verb
RAMP REORGThe PR's surface change shifts a concept across promises (e.g. an enterprise feature becomes consumer-default)Policy enforcement moves from enterprise to consumer default behaviour

The structural shape drives the TOC delta shape.

Step 3: design the TOC delta

For each new page proposed, fill in:

new_page:
  slug: docs/src/content/docs/<persona>/<topic>.md
  title: "<short imperative title>"
  persona: consumer | producer | enterprise | cross
  promise: 1 | 2 | 3 | cross
  parent_chapter: <existing chapter slug>
  h2_sections:
    - "## Why <topic>"        # OPTIONAL -- skip unless concept is genuinely new
    - "## How to <use>"        # REQUIRED -- code first
    - "## Reference"           # OPTIONAL -- flag/option table
    - "## Troubleshooting"     # OPTIONAL -- only if known footguns
  bridges:
    incoming:                  # which existing pages should link TO this
      - {from: <slug>, link_text: <suggested>}
    outgoing:                  # which existing pages should this link FROM
      - {to: <slug>, link_text: <suggested>}
  ramp_impact: >-
    one-paragraph description of how this changes the <persona>
    ramp: which step it slots into, whether it adds a stop or
    replaces an existing one

For each moved/retired page:

moved_page:
  from: <slug>
  to: <slug>
  redirect_rationale: <one-sentence>

retired_page:
  slug: <slug>
  reason: <one-sentence>
  redirect_to: <slug>  # MUST exist; orphaning pages breaks SEO

Step 4: validate against the 3-promise narrative

Apply these hard rules. If any fails, redesign:

  1. Every page belongs to exactly one promise. Cross-cutting pages (integrations, troubleshooting, reference) are explicitly marked promise: cross. If a new page straddles two promises, split it OR park it under cross.
  2. Consumer pages don't pre-teach producer concepts. A consumer page may LINK to producer; it may not embed producer prose.
  3. Producer pages don't pre-teach enterprise concepts. Same rule, one promise down.
  4. No page is orphaned from the TOC. Every new page has a parent_chapter and at least one incoming bridge.
  5. No retired page lacks a redirect_to. Search engines will index the old URL for months; the redirect is the SEO contract.

Step 5: emit the architect report

Return JSON:

{
  "structural_shape": "NEW CAPABILITY" | "EXPANDED CAPABILITY" | "DEPRECATED CAPABILITY" | "CONCEPT SPLIT" | "CONCEPT MERGE" | "RAMP REORG",
  "toc_delta": {
    "new_pages": [...],
    "moved_pages": [...],
    "retired_pages": [...],
    "chapter_changes": [...]
  },
  "promise_validation": {
    "all_pages_single_promise": true | false,
    "no_orphans": true | false,
    "no_unredirected_retires": true | false,
    "concerns": []
  },
  "downstream_in_place_pages": ["..."],
  "rationale": "<2-3 sentence summary of why this structural delta and not alternatives>"
}

downstream_in_place_pages[] is the handoff to the localizer -- after the architect approves the TOC, the localizer plans in-place edits to existing pages that REFERENCE the new structure.

Output contract

Return a SINGLE JSON document matching the schema in Step 5 as the final message of your task. No prose around the JSON.

Anti-patterns

  • Inflating new-page counts to seem thorough. The minimal true delta wins.
  • Skipping the promise-validation step. The CDO will catch it; better to self-catch.
  • Designing a new chapter when an existing chapter has room. Always prefer extending over creating.
  • Forgetting redirect_to on retired pages. SEO debt is the silent corpus killer.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Review OpenAPM specification changes through four specialist perspectives covering schemas, registries, dependency resolution, and web architecture. The skill combines findings and mechanical checks into one advisory comment, separating immediate fixes from work deferred to later versions.

中文简介正在准备中。当前显示英语简介。

  • Reviewing OpenAPM specification changes
  • Checking JSON Schemas and conformance fixtures
  • Separating immediate fixes from future version work
microsoft/apm40952026年10月20日 更新

Review APM positioning, public documentation, release communication, and breaking-change decisions using GitHub evidence. Check that incompatible changes include changelog entries and migration notes, and resolve disagreements among the project's specialist reviewers.

中文简介正在准备中。当前显示英语简介。

  • Reviewing project positioning in public documents
  • Checking changelogs and release communication
  • Confirming migration guidance for breaking changes
microsoft/apm40952026年10月20日 更新

apm-usage

免费

Get guidance on using APM, a package manager for AI agents, to install and share reusable instructions, skills, and server configurations. Covers dependencies, package creation, authentication, policy checks, CLI commands, and troubleshooting.

中文简介正在准备中。当前显示英语简介。

  • Install and restore AI-agent packages
  • Configure MCP and LSP servers
  • Create and share APM packages
microsoft/apm40952026年10月20日 更新

auth

免费

Guide authentication changes in APM CLI for GitHub and Azure DevOps. Centralizes credential lookup through AuthResolver and explains token precedence, Azure CLI fallback, Git credential helper retries, and error messages for failed authentication.

中文简介正在准备中。当前显示英语简介。

  • Updating token lookup and precedence
  • Fixing authentication during Git operations
  • Reviewing Azure DevOps fallback behavior
microsoft/apm40952026年10月20日 更新

Post or update one GitHub comment for an APM autopilot run. The skill assembles public or debug content, adds an AI-generated disclaimer, and supports previewing the assembled comment before posting.

中文简介正在准备中。当前显示英语简介。

  • Post an autopilot result to an Issue
  • Update an existing pull request comment
  • Preview a comment before posting
microsoft/apm40952026年10月20日 更新

Build an implementation queue from accepted GitHub issues and distribute them to dedicated workers. Record selection reasons, check for existing pull requests, and process the full queue with a configurable concurrency limit, defaulting to two workers.

中文简介正在准备中。当前显示英语简介。

  • Queue accepted issues for implementation
  • Limit concurrent issue delivery workers
  • Record why issues were included or skipped
microsoft/apm40952026年10月20日 更新

查看 microsoft 的全部技能

报告此技能的问题