Agent Skills › Azure/agent-landing-zone › documentation-consistency

documentation-consistency

GitHub

确保 Agent Landing Zone 用户与操作员文档与发布行为一致。用于同步功能、配置、部署参数及组件版本等变更，更新相关页面并注册新页，保持示例准确性。

.github/skills/documentation-consistency/SKILL.md Azure/agent-landing-zone

触发场景

功能或配置变更导致用户行为改变需要更新文档以反映新的默认值或组件版本

安装

npx skills add Azure/agent-landing-zone --skill documentation-consistency -g -y

更多选项

非标准路径

npx skills add https://github.com/Azure/agent-landing-zone/tree/main/.github/skills/documentation-consistency -g -y

不安装直接使用

npx skills use Azure/agent-landing-zone@documentation-consistency

指定 Agent (Claude Code)

npx skills add Azure/agent-landing-zone --skill documentation-consistency -a claude-code -g -y

安装 repo 全部 skill

npx skills add Azure/agent-landing-zone --all -g -y

预览 repo 内 skill

npx skills add Azure/agent-landing-zone --list

SKILL.md

Frontmatter

{
    "name": "documentation-consistency",
    "description": "Keeps Agent Landing Zone user and operator documentation aligned with shipped behavior. Use for features, configuration keys, deployment parameters, defaults, component pins, operations, or breaking changes."
}

Agent Landing Zone documentation consistency

User-facing documentation lives on the docs branch of Azure/agent-landing-zone and is published at https://azure.github.io/agent-landing-zone/.

Identify the user or operator behavior that changed.
Search the documentation source for the feature, configuration key, parameter, component, and previous terminology.
Update every affected page in the same coordinated change.
Register new pages in mkdocs.yml.
Keep repository and service READMEs concise; link to the published site instead of duplicating product guidance.
Ensure examples match current defaults, supported deployment modes, and shipped component versions.
Report the documentation branch or pull request in the implementation handoff.

A user-visible change is incomplete until documentation is updated or the search demonstrates that no published page is affected.