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

documentation-consistency

GitHub

确保AI着陆区文档与Bicep代码行为一致，涵盖参数、拓扑及发布流程。适用于更新README、MkDocs及示例，保持贡献者、用户和操作者文档同步。

infra/.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/infra/.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 AI Landing Zone contributor, user, and operator documentation aligned with shipped Bicep behavior. Use for parameters, defaults, outputs, topology, deployment flow, operations, or releases."
}

AI Landing Zone documentation consistency

Identify the user, consumer, contributor, or operator behavior that changed.
Search README.md, CHANGELOG.md, docs/, pipelines/README.md, examples, and tests for the parameter, output, flag, topology, command, and old term.
Update every affected in-repository source in the same change.
When the public Bicep landing-zone narrative changes, update the MkDocs source on Azure/AI-Landing-Zones main and link the companion pull request.
Keep examples aligned with current defaults and both standard and network- isolated modes.
Classify semantic-version impact and record migration guidance for breaking behavior.
Report documentation status and any coordinated pull request in the handoff.

Generated gh-pages content is not an editable documentation source. A user- visible change is incomplete until documentation is updated or a search proves that no published page is affected.