skills.rest
rcrespodev
rcrespodevCOMMUNITY
Explore all skills by this author →
GitHub

living-docs

Generates Markdown documentation from git diffs with Obsidian-compatible YAML frontmatter.

1|Updated Feb 13, 2026
Search Tags:#git#changelog#documentation#adr#code changes#runbook
One-click install
npx skills add https://github.com/rcrespodev/rcrespodev-skills --skill living-docs-rcrespodev
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: living-docs
Source: https://github.com/rcrespodev/rcrespodev-skills/tree/main/skills/living-docs
Command: npx skills add https://github.com/rcrespodev/rcrespodev-skills --skill living-docs-rcrespodev

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the creation and updating of essential documentation directly from your code changes, ensuring your documentation is always in sync with your codebase and reducing manual effort.

Core Features & Use Cases

  • Automated Documentation Generation: Creates Component Docs, Changelogs, ADRs, and Runbooks in Markdown format.
  • Contextual Updates: Analyzes git diffs (branch comparisons or last N commits) to identify relevant changes.
  • Use Case: After merging a feature branch, use this Skill to automatically generate release notes and update the service's component documentation, reflecting all new endpoints and bug fixes.

Quick Start

Use the living-docs skill to document the changes from the 'develop' branch.

Frequently Asked Questions about living-docs

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

FAQPage Schema
How do I generate changelogs and release notes from git diffs?▼

You can generate changelogs and release notes from git diffs by analyzing branch comparisons or the last N commits. This process automatically creates Markdown documentation with Obsidian-compatible YAML frontmatter reflecting your code changes.

Can I automatically create Architecture Decision Records from code changes?▼

Yes, you can automatically create Architecture Decision Records (ADRs) from code changes. By analyzing branch comparisons, the system identifies architectural modifications and generates corresponding ADRs in Markdown format.

What is the best way to keep component documentation in sync with my codebase?▼

The best way to keep component documentation in sync is to automate generation directly from git commits. This ensures your component docs, runbooks, and changelogs accurately reflect all new endpoints, features, and bug fixes after every merge.

Does living documentation generation work with Obsidian YAML frontmatter?▼

Yes, living documentation generation works with Obsidian by producing Markdown files that include Obsidian-compatible YAML frontmatter. This ensures the generated component docs, ADRs, and runbooks integrate seamlessly into your Obsidian knowledge base.

How do I update service documentation after merging a feature branch?▼

To update service documentation after merging a feature branch, analyze the branch diff against the main branch. This automatically extracts new endpoints and bug fixes to update your component documentation and generate relevant release notes.

Related Skills

Explore More Software Engineering Skills→
sfc-gh-dflipposfc-gh-dflippo
34

skills-sync

Synchronizes AI agent skills from local SKILL.md files and remote Git repositories.

Community
Intermediate
mindmorassmindmorass
2

obsidian-publisher

Write Markdown notes and Mermaid diagrams into Obsidian vault folders.

Community
Basic
hatch3rhatch3r
26

hatch3r-gh-agentic-workflows

Configure CI/CD agentic workflows across GitHub Actions, Azure Pipelines, and GitLab CI.

Official
Advanced
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced