agentleFS
Sign inStart free
GitHubKnown publishergithub/squad/.copilot/skills/documentation-maintenance/SKILL.md

documentation-maintenance

Skill3.4k starsChanged 2 months agoMITView on GitHub

Maintain accurate, scannable Squad documentation with validated inventory and links

6 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 6 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use this skill when adding, removing, or materially changing user-facing documentation.

    line 11
  2. Distinctive:

    Follow the Microsoft Style Guide: sentence-case headings, active voice, second person, and present tense unless established project voice …

    line 17
  3. Distinctive:

    Keep one canonical page per concept.

    line 19
  4. Very specific:

    When a page is added or removed, update the relevant expected-inventory arrays in test/docs-build.test.ts in the same change.

    line 23

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

Context

Use this skill when adding, removing, or materially changing user-facing documentation. Squad documentation should describe the product and its supported configuration, not surrounding infrastructure presented as product behavior.

Patterns

  • Follow the Microsoft Style Guide: sentence-case headings, active voice, second person, and present tense unless established project voice requires an exception.
  • Keep one canonical page per concept. Link to it rather than duplicating content, using the most specific stable anchor available.
  • Choose paragraphs for explanation, parallel lists for scannable choices or steps, and tables for comparisons or reference data.
  • When a page is added or removed, update the relevant expected-inventory arrays in test/docs-build.test.ts in the same change.
  • Review behavior changes for documentation impact. Update affected docs or explicitly record why no user-facing documentation changes.

Examples

.github/PR_REQUIREMENTS.md requires a docs-build test update for a new feature page. test/docs-build.test.ts verifies the expected guide, feature, scenario, concept, and reference inventories against the filesystem.

Anti-Patterns

  • Presenting external deployment wrappers, bots, or unrelated infrastructure as Squad features
  • Adding a page without checking the inventory assertions
  • Duplicating a concept across several pages instead of linking to the canonical explanation

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.

Reviews can't be read right now.

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