Skip to main content

documentation-maintenance

Maintain accurate, scannable Squad documentation with validated inventory and links

Quellinformationen

Repository
bradygaster/squad
Letzte Quellaktivität
11. September 2026 um 21:27
Erkannte Sprache von SKILL.md
Englisch
Sterne
3.285
Forks
508

Installationsoptionen

Standardmäßig ist der Prompt ausgewählt, der zuerst die Quelle prüft. Sie können zu einem direkten Befehl wechseln oder eine lokale Kopie herunterladen.

Quelldateien prüfen

Lesen Sie SKILL.md und alle von SkillsMP angezeigten Begleitdateien, bevor Sie sich für eine Installation entscheiden.

SKILL.md wird angezeigt

SKILL.md
Quellanweisungen · Schreibgeschützte Vorschau
name
documentation-maintenance
description
Maintain accurate, scannable Squad documentation with validated inventory and links
domain
documentation
confidence
high
source
current documentation tests and repository requirements
## 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
Auf GitHub ansehen