skills.rest
robotijn
robotijnCOMMUNITY
Explore all skills by this author →
GitHub

documentation-updater

Detect and resolve documentation drift across codebases and associated assets.

3|2|Updated Jan 23, 2026
Search Tags:#changelog#documentation#openapi#adr#docstrings#api-docs#code-drift
One-click install
npx skills add https://github.com/robotijn/ctoc --skill documentation-updater-robotijn
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-updater
Source: https://github.com/robotijn/ctoc/tree/main/skills/documentation/documentation-updater
Command: npx skills add https://github.com/robotijn/ctoc --skill documentation-updater-robotijn

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drifts faster than code as features are added, renamed, or removed, leading to broken references, missing guidance for new functionality, and outdated instructions that waste developer time and confuse end users.

Core Features & Use Cases

  • Drift Detection: Identifies stale docs, broken links, missing API documentation, absent architectural decision records (ADRs), and mismatches between code symbols and their documented references.
  • Automated Updates: Syncs API docs (via OpenAPI, JSDoc, Sphinx, etc.), READMEs, code docstrings, changelogs, and generates migration guides for breaking changes.
  • Use Case: After merging a PR that adds a new public API endpoint and renames an existing function, the skill updates the OpenAPI spec, adds the new endpoint to the API docs, updates references to the renamed function across all docs, and adds a migration entry to the changelog.

Quick Start

Use the documentation-updater skill to sync all project documentation with the latest code changes after your most recent feature merge.

Frequently Asked Questions about documentation-updater

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

FAQPage Schema
How do I detect and fix documentation drift after merging code changes?▼

Documentation drift is detected by scanning codebases for stale content, broken links, missing API docs, and absent ADRs. The skill resolves these mismatches by syncing API specs, READMEs, docstrings, and changelogs with the latest code.

How do I automatically generate API docs and update OpenAPI specs from source code?▼

API docs and OpenAPI specs are auto-generated from source code annotations across 7 programming languages. When public endpoints change, the skill updates the spec, adds endpoints to API docs, and appends migration entries to the changelog.

What is the best way to maintain changelogs and create migration guides for breaking changes?▼

Changelogs and migration guides are maintained by tracking codebase changes and validating ADR compliance. When breaking changes merge, the skill automatically generates migration guide entries and updates the changelog.

Does this documentation updater work with my programming language and CI-enforced link testing?▼

Yes, it supports software engineering workflows across 7 programming languages. It enforces docs-as-code best practices including Diataxis information architecture and CI-enforced link and snippet testing.

Why are my README references broken after renaming a function in the codebase?▼

Broken README references occur when code symbols are renamed without updating documented references. The skill detects mismatches between code symbols and their docs, then updates all references across the documentation.

When do I need architectural decision records validation for my software engineering workflow?▼

ADR validation is needed when enforcing documentation best practices like docs-as-code. The skill detects absent ADRs and validates compliance to ensure architectural decisions are properly documented alongside code changes.

Related Skills

Explore More Software Engineering Skills→
thktthkt
11

documenting-apis

Generate Markdown API specs and OpenAPI/Swagger files from codebase analysis.

Community
Advanced
Coffelix2023Coffelix2023
1

code-documenter

Generate inline code documentation, API specifications, and developer guides.

Community
Intermediate
massgenmassgen
1.1k

pr-checks

Automate PR checks with pre-commit hooks, tests, and CodeRabbit feedback.

Official
Advanced
marcoguillermazmarcoguillermaz
3

doc-audit

Detect and report documentation drift in repository docs as structured markdown reports.

Community
Advanced