agentleFS
Sign inStart free
Microsoft AzureKnown publisherAzure/agent-app-orchestrator/.github/skills/documentation-consistency/SKILL.md

documentation-consistency

Skill107 starsChanged 3 days agoMITView on GitHub

Keeps Agent Landing Zone Orchestrator user and operator documentation aligned with shipped behavior. Use for runtime strategies, APIs, configuration keys, deployment, defaults, operations, or breaking changes.

We split this skill into the rules it gives an agent

6 rules. 0 are common, 6 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 9 edited versions we read keep these.

  • 6

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep engineering instructions, governance policies, ADRs, and executable contracts local.

    line 11
  2. Distinctive:

    Search the documentation source for the feature, API, strategy, configuration key, parameter, component, and previous terminology.

    line 15
  3. Distinctive:

    Update every affected page in the same coordinated change.

    line 17
  4. Distinctive:

    Keep component READMEs concise and link to published topics.

    line 19
  5. Distinctive:

    Ensure examples match current defaults, supported runtime strategies, configuration labels, authentication, deployment modes, and rollback.

    line 21
  6. Distinctive:

    Update this repository's README links when central topics change.

    line 23

“Common” is measured: kept by at least 6 in 10 of the 9 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Agent Landing Zone Orchestrator documentation consistency

Product, operator, and developer guides live only in Azure/AI-Landing-Zones on main and are published at https://azure.github.io/AI-Landing-Zones/agent-landing-zone/. Keep engineering instructions, governance policies, ADRs, and executable contracts local.

  1. Identify the user or operator behavior that changed.
  2. Search the documentation source for the feature, API, strategy, configuration key, parameter, component, and previous terminology.
  3. Update every affected page in the same coordinated change.
  4. Register new pages under nav: in the central repository's mkdocs.yml.
  5. Keep component READMEs concise and link to published topics. Do not reintroduce local product, operator, or developer guides.
  6. Ensure examples match current defaults, supported runtime strategies, configuration labels, authentication, deployment modes, and rollback.
  7. Update this repository's README links when central topics change. Local startup and testing guidance belongs in local development and application testing.
  8. Report the central documentation commit or pull request in the implementation handoff.

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

Download now (ZIP)

  • Other versions10 projects use a version of this.

    Word for word · 1

    1. Azure/gpt-rag-orchestrator★ 107100% same

    Edited · 8

    1. Azure/agent-landing-zone★ 1.2k41% same
    2. Azure/GPT-RAG★ 1.2k41% same
    3. Azure/agent-app-ingestion★ 18812% same
    4. Azure/gpt-rag-ingestion★ 18812% same
    5. Azure/gpt-rag-mcp★ 2212% same
    6. Azure/bicep-ptn-aiml-landing-zone★ 1911% same
    7. Azure/agent-app-ui★ 1019% same
    8. Azure/gpt-rag-ui★ 1019% same

    Wrote their own version · 1

    1. wallstop/unity-helpers★ 176same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • Used alongsideProjects with it also use speckit-converge, speckit-taskstoissues and 8 more.

    Other files people use alongside this one.

    Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
    • Microsoft AzureSkill

      speckit-converge

      Assess the current codebase against the feature's spec, plan, and tasks, then append any remaining unbuilt work as new tasks to tasks.md so implement can complete it.

      Also in 3 projects that use this

    • Microsoft AzureSkill

      speckit-taskstoissues

      Convert existing tasks into actionable, dependency-ordered GitHub issues for the feature based on available design artifacts.

      Also in 3 projects that use this

    • +8 more from Azure
  • In this repository6 other files it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free