agentleFS
Microsoft AzureKnown publisherAzure/agent-app-ingestion/.github/skills/documentation-consistency/SKILL.md

documentation-consistency

Skill188 starsChanged 13 days agoMITView on GitHub

Keeps ingestion repository and published Agent Landing Zone documentation aligned with shipped formats, configuration, indexing, deployment, audit, and operator behavior.

11 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use component-release.

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

    component-release

    Prepares a verifiable Agent Landing Zone UI release. Use for release branches, VERSION, changelog entries, tags, release notes, and compatibility evidence; never publish without explicit human approval.

    Also in 4 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 10 edited versions we read keep these.

  • 4

    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:

    Search this repository for the format, configuration key, index field, endpoint, job type, contract, and previous terminology.

    line 9
  2. Distinctive:

    Keep component READMEs limited to concise descriptions and central pointers.

    line 11
  3. Distinctive:

    Keep internal engineering instructions, ADRs, schemas, contracts, governance, workflows, policies, and changelogs local.

    line 12
  4. Distinctive:

    Ensure examples match current defaults, App Configuration labels, supported deployment modes, and released component behavior.

    line 21

“Common” is measured: kept by at least 6 in 10 of the 10 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

Ingestion documentation consistency

  1. Identify the user, operator, developer, or cross-component behavior that changed.
  2. Search this repository for the format, configuration key, index field, endpoint, job type, contract, and previous terminology.
  3. Keep component READMEs limited to concise descriptions and central pointers. Keep internal engineering instructions, ADRs, schemas, contracts, governance, workflows, policies, and changelogs local.
  4. Search main of Azure/AI-Landing-Zones for all affected application user, operator, and developer guides. Update every affected page in the coordinated change. Audit guidance belongs in Monitoring & audit, backed by executable local contracts, telemetry, and tests.
  5. Register new published pages in that repository's mkdocs.yml.
  6. Ensure examples match current defaults, App Configuration labels, supported deployment modes, and released component behavior.

Publish application guides at https://azure.github.io/AI-Landing-Zones/agent-landing-zone/ rather than duplicating them locally. Report the central source commit or pull request and publication status in the implementation handoff.

Download now (ZIP)

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.