How do I install the Standards skill?

Run npx skillmds@latest add xiaolai/standards in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Standards safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Standards?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Standards free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Standards?

xiaolai (@xiaolai) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Standards by xiaolai — Agent Skill

Name: Standards
Author: xiaolai

File contents

Documentation Guardian Standards

Severity Tags

Tag	Meaning	When to use
`CRITICAL`	Documentation is dangerously wrong — will mislead users into bugs or security issues	API signature changed but docs show old signature; security-relevant parameter undocumented
`HIGH`	Documentation is missing or significantly stale — users will struggle	Public function has no docs; doc references deleted parameter
`MEDIUM`	Documentation exists but is incomplete or outdated in non-critical ways	Missing examples; parameter description vague; minor version drift
`LOW`	Documentation quality issue — cosmetic or style	Typos; inconsistent heading levels; missing period at end of sentence
`INFO`	Observation, not a problem	Unusually thorough docs; suggestion for improvement

Finding Format

Every finding reported by an agent MUST use this structure:

### [SEVERITY] Short title

- **File**: `path/to/file`
- **Line**: 42 (if applicable)
- **Related doc**: `docs/path/to/doc.md` (if applicable)
- **Detail**: One-paragraph explanation of the issue.
- **Suggestion**: Concrete action to fix it.

Agent Output Header

Every agent output MUST begin with:

## <Agent Name> Report

**Scanned**: <number> files
**Findings**: <number> (Critical: N, High: N, Medium: N, Low: N, Info: N)
**Timestamp**: <ISO 8601>

Coverage Metrics

Coverage is reported as a percentage:

coverage% = (documented_public_symbols / total_public_symbols) × 100

A "documented" symbol has at minimum:

A description of what it does
Parameter/argument documentation (if callable)
Return value documentation (if applicable)

Staleness Metrics

Staleness is measured by comparing:

code_last_modified: last git commit touching the source file
doc_last_modified: last git commit touching the corresponding doc file

A doc is stale when code_last_modified - doc_last_modified > stalenessThresholdDays (from config).

Quality Score

Quality is rated 0–100 based on:

Factor	Weight	Criteria
Completeness	30%	All public APIs documented
Accuracy	30%	Docs match current code
Freshness	20%	No stale docs beyond threshold
Readability	10%	Clear language, good structure
Examples	10%	Working code examples present

---name: standardsdescription: Use when evaluating documentation quality — check completeness, accuracy, freshness, and adherence to project documentation standards.---# Documentation Guardian Standards## Severity Tags| Tag | Meaning | When to use ||-----|---------|-------------|| `CRITICAL` | Documentation is dangerously wrong — will mislead users into bugs or security issues | API signature changed but docs show old signature; security-relevant parameter undocumented || `HIGH` | Documentation is missing or significantly stale — users will struggle | Public function has no docs; doc references deleted parameter || `MEDIUM` | Documentation exists but is incomplete or outdated in non-critical ways | Missing examples; parameter description vague; minor version drift || `LOW` | Documentation quality issue — cosmetic or style | Typos; inconsistent heading levels; missing period at end of sentence || `INFO` | Observation, not a problem | Unusually thorough docs; suggestion for improvement |## Finding FormatEvery finding reported by an agent MUST use this structure:```### [SEVERITY] Short title- **File**: `path/to/file`- **Line**: 42 (if applicable)- **Related doc**: `docs/path/to/doc.md` (if applicable)- **Detail**: One-paragraph explanation of the issue.- **Suggestion**: Concrete action to fix it.```## Agent Output HeaderEvery agent output MUST begin with:```## <Agent Name> Report**Scanned**: <number> files**Findings**: <number> (Critical: N, High: N, Medium: N, Low: N, Info: N)**Timestamp**: <ISO 8601>```## Coverage MetricsCoverage is reported as a percentage:```coverage% = (documented_public_symbols / total_public_symbols) × 100```A "documented" symbol has at minimum:1. A description of what it does2. Parameter/argument documentation (if callable)3. Return value documentation (if applicable)## Staleness MetricsStaleness is measured by comparing:- `code_last_modified`: last git commit touching the source file- `doc_last_modified`: last git commit touching the corresponding doc fileA doc is **stale** when `code_last_modified - doc_last_modified > stalenessThresholdDays` (from config).## Quality ScoreQuality is rated 0–100 based on:| Factor | Weight | Criteria ||--------|--------|----------|| Completeness | 30% | All public APIs documented || Accuracy | 30% | Docs match current code || Freshness | 20% | No stale docs beyond threshold || Readability | 10% | Clear language, good structure || Examples | 10% | Working code examples present |

Frequently asked questions

Standards