Skills
.Work. You
Rest

Documenter Skill

Community

Automate documentation updates, keep specs in sync.

Content & Communication#automation#changelog#documentation#technical writing#API docs#README#spec synchronization
AuthordeMGoncalves
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill ensures that all project documentation—from README.md to API references and CHANGELOG.md—is consistently updated and synchronized with the latest code changes. It automates the often-overlooked task of documentation, preventing outdated or missing information.

Core Features & Use Cases

  • Comprehensive Documentation Updates: Automatically updates various documentation artifacts, including README.md, CHANGELOG.md, API documentation, and code comments, reflecting new features, bug fixes, and refactorings.
  • Specification Synchronization: Ensures that specs/ documents (e.g., Arc42 views, BDD scenarios) are aligned with the implemented code, maintaining a single source of truth.
  • Doc Comment Generation: Generates or updates doc comments for public APIs, functions, and modules, improving code readability and maintainability.
  • Use Case: After a new feature is implemented and reviewed, this Skill automatically updates the README.md with usage instructions, adds an entry to CHANGELOG.md, and ensures all relevant specs/ are synchronized, saving developers from manual documentation tasks.

Quick Start

After code review is complete, invoke the Documenter to update all relevant documentation: @skill documenter

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: Documenter Skill
Download link: https://github.com/deMGoncalves/arq-specs-template/archive/main.zip#documenter-skill

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository