skills.rest
psd401
psd401OFFICIAL
Explore all skills by this author →
Website𝕏@psd401GitHub

meta-document

Generate and synchronize living documentation from code changes, PRs, and commits.

2|3|Updated Oct 20, 2025
Search Tags:#automation#documentation#validation#code changes#living docs#PR sync
One-click install
npx skills add https://github.com/psd401/psd-claude-coding-system --skill meta-document
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: meta-document
Source: https://github.com/psd401/psd-claude-coding-system/tree/main/plugins/psd-claude-coding-system/skills/meta-document
Command: npx skills add https://github.com/psd401/psd-claude-coding-system --skill meta-document

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Living code bases often drift from their documentation, making it hard for new contributors and stakeholders to understand system behavior and decisions. The meta-document skill automatically generates and synchronizes living documentation from code changes, PRs, and commits, ensuring the docs reflect the latest implementation.

Core Features & Use Cases

  • Auto-generation from changes: Scans commits and PRs to extract patterns, anti-patterns, and architecture updates, creating or updating docs in docs/patterns and CLAUDE.md.
  • Self-validating living docs: Includes executable detection scripts and tests that verify docs stay aligned with code, with nightly checks where applicable.
  • Real-world references and governance: Maintains references to PRs, issues, and related incidents, aiding governance and onboarding.
  • Immediate quick-start workflows: Provides commands to sync from code, validate patterns, and derive docs from recent changes.

Quick Start

Use the meta-document tool to generate or refresh living documentation from code changes:

  • Sync from code: /meta-document --sync-from-code
  • Validate existing patterns: /meta-document --validate-patterns
  • Generate from PR: /meta-document --from-pr <PR_NUMBER>

Frequently Asked Questions about meta-document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep documentation automatically in sync with code changes?▼

Living documentation stays synchronized with code by analyzing commits and PRs to auto-generate and update docs. Meta-document scans code changes to extract patterns and architecture updates, creating or refreshing documentation in docs/patterns and CLAUDE.md so docs reflect the latest implementation without manual effort.

Can I validate that my documentation matches the current codebase?▼

Yes, validation checks whether documentation aligns with code through executable detection scripts and automated tests. Run `/meta-document --validate-patterns` to verify docs stay consistent with your implementation, with nightly checks available for ongoing governance.

How do I generate documentation from recent pull requests and commits?▼

Extract documentation from code changes by scanning PR and commit history. Use `/meta-document --sync-from-code` to generate docs from changes, or `/meta-document --from-pr <PR_NUMBER>` to derive documentation from a specific pull request.

What should I document to help new contributors understand system decisions?▼

Document patterns, anti-patterns, and architecture decisions by maintaining references to PRs, issues, and related incidents. Living docs generated from code changes create a record of how and why implementation evolved, reducing onboarding friction and supporting governance.

Do I need to manually update docs when I fix bugs or add features?▼

No. Meta-document automatically generates and synchronizes living documentation from code changes. When commits and PRs update implementation, docs can be refreshed using `/meta-document --sync-from-code` to reflect the latest behavior and decisions without manual doc maintenance.

Related Skills

Explore More Software Engineering Skills→
bitwardenbitwarden
129

analyzing-git-sessions

Analyze git activity within time or commit ranges to produce structured summaries.

Official
Basic
unfinishablemapunfinishablemap
3

expand-topic

Generate a publish-ready article draft from a topic prompt.

Community
Intermediate
HerxinsasaHerxinsasa
1

commit-assistant

Automate pre-commit code review and commit message generation for Git and SVN repositories.

Community
Advanced
CsHengCsHeng
10

language-go

Validate Go code through compilation, linting, testing, and dependency checks.

Community
Advanced