smithery.ai

documentation-consistency-keeper

Keeps all project documents consistent after code or spec changes. Use after any approved update.

First seen Mar 22, 2026

Installation

$ npx skills add https://smithery.ai

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from smithery.ai · top by installs.

npx skills add https://smithery.ai

Browse all from smithery.ai

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 2,117 B
  • docs SUMMARY.md 137 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 1 installs

SKILL.md

Documentation Consistency Keeper

Purpose

Ensures all project documentation stays synchronized after spec or code changes. Outdated documentation is technical debt that causes confusion and errors.


When to Use

  • After spec updates
  • After major code changes
  • After API contract changes
  • Before release

Instructions

1. Identify Dependent Documents

## Document Dependency Map

**Changed:** spec/auth.md (AUTH-001 updated)

**Dependent Documents:**
- [ ] README.md - mentions auth flow
- [ ] docs/api.md - auth endpoint docs
- [ ] CHANGELOG.md - needs entry
- [ ] docs/security.md - references token expiry

2. Update Terminology and References

Old Term New Term Files Affected
"1 hour token" "24 hour token" api.md, README
"session expiry" "token expiry" security.md

3. Remove Outdated Statements

## Outdated Content Removed

**File:** docs/api.md
**Line 42:** "Tokens expire after 1 hour" → REMOVED
**Replaced With:** "Tokens expire after 24 hours (AUTH-001)"

4. Produce Change Summary

## Documentation Update Summary

**Trigger:** AUTH-001 spec update (token expiry change)
**Date:** 2026-01-22

### Files Updated
| File | Changes |
|------|---------|
| README.md | Updated auth section |
| docs/api.md | Fixed endpoint docs |
| CHANGELOG.md | Added entry |

### Verification
- [ ] All links still work
- [ ] No orphaned references
- [ ] Version numbers consistent

Integration

  • Precedes: project-regression-checklist
  • Follows: spec-auto-updater
  • Validates: Doc-to-code consistency

Constraints

  • Outdated docs are technical debt
  • All spec changes must cascade to docs
  • Version numbers must stay synchronized

Docs must match reality.