CtrlK
BlogDocsLog inGet started
Tessl Logo

documentation-maintenance

Maintain accurate, scannable Squad documentation with validated inventory and links

55

Quality

63%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./.copilot/skills/documentation-maintenance/SKILL.md
SKILL.md
Quality
Evals
Security

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
Repository
bradygaster/squad
Last updated
First committed

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.