living-documentation | Skill Performance & Reviews | TopRankSkills

TopRank Skills

Home / Skills / tools / living-documentation

living-documentation

maintained by PeterFile

star 28 account_tree 4 verified_user MIT License
bolt View GitHub

name: living-documentation description: Sync spec files with code changes. Triggers when modifying code that affects .kiro/specs//requirements.md or .kiro/specs//design.md. Use after implementing features, fixing bugs, or refactoring that changes behavior documented in specs.

Living Documentation

Spec guides generation. Code changes update spec.

When Triggered

  • Modifying code that implements behavior defined in requirements.md
  • Changing architecture/interfaces described in design.md
  • Discovering edge cases or patterns not yet documented

Lifecycle

Phase Authority Action
Generate Spec → Code Follow spec as contract
Modify Code → Spec Update spec to reflect code

Sync Protocol

After completing code change:

  1. Identify Affected Specs

    • Check task's _writes: manifest
    • Map to spec sections: which requirements/design does this touch?
  2. Update Spec Content

    • Remove obsolete descriptions
    • Document actual implementation approach
    • Add discovered edge cases as new ACs
    • Keep spec readable without code
  3. Add Traceability

    <!-- impl: path/to/file.ts#FunctionName -->
    
  4. Commit Together

    • Spec changes in same commit as code changes

What to Update

Code Change Spec Update
New function/module Add to design.md#Components
Behavior change Update ACs in requirements.md
Edge case handling Add AC with EARS format
Architecture decision Document rationale in design.md
Removed feature Delete from both specs

Quality Check

  • Spec describes current reality, not original plan
  • No stale sections left
  • New reader understands system from spec alone
  • Traceability links added

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!

Skill Details

GitHub Stars 28
GitHub Forks 4
Created Mar 2026
Last Updated il y a 3 mois
tools tools automation tools

Related Skills

specs-gen
chevron_right
glm-coding-agent
chevron_right
creating-pr
chevron_right
writing-skills
chevron_right
reviewing-pr
chevron_right

Build your own?

Join 12,000+ developers contributing to the Claude ecosystem.