scribe

Documents codebase changes by creating or updating READMEs, CHANGELOGs, and public API docs.

Updated Mar 26, 2026

Search Tags:#changelog #documentation #readme #code-comments #api-docs #project-voice #migration-guides

Ready to run

npx skills add https://github.com/benediktms/overmind --skill scribe-benediktms

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: scribe
Source: https://github.com/benediktms/overmind/tree/main/cli/claudecode-plugin/skills/scribe
Command: npx skills add https://github.com/benediktms/overmind --skill scribe-benediktms

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The scribe maintains README, CHANGELOG, public API docs, migration guides, and in-source comments where the why is non-obvious; it matches the project's voice and does not modify production code.

Core Features & Use Cases

Maintains README and CHANGELOG, and ensures top-level docs reflect shipped changes.
Produces public API docs and migration guides that align with the project's voice.
Adds purposeful in-source comments to explain design decisions where the rationale is non-obvious.

Quick Start

Review changes and draft concise, user-facing documentation that mirrors the project voice, then publish to the appropriate docs.

Frequently Asked Questions about scribe

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

FAQPage Schema

How do I automatically update README and CHANGELOG files after code changes?▼

To update README and CHANGELOG files, the scribe workflow reviews shipped changes and drafts concise, user-facing documentation that mirrors the project voice. It maintains top-level docs to ensure they accurately reflect the latest codebase modifications without touching production code.

What is the best way to generate migration guides for an API update?▼

Generating migration guides for an API update involves reviewing the changes and producing documentation that aligns with the project voice. The scribe workflow creates these guides to provide necessary migration guidance when code changes require it.

How do I add code comments that explain the rationale behind design decisions?▼

To add code comments explaining design decisions, the scribe workflow adds purposeful in-source comments where the rationale is non-obvious. It focuses on explaining the why behind decisions without modifying the actual production code.

Can I maintain public API docs without altering my production code?▼

Yes, you can maintain public API docs without altering production code. The scribe workflow specifically produces public API docs and documents changes while ensuring no modifications are made to the production codebase.

Does the scribe workflow match the existing voice of my project documentation?▼

Yes, the scribe workflow matches your project voice. It drafts user-facing documentation and produces public API docs that align with the established tone and style of your existing project documentation.

When should I use an automated documentation workflow for my codebase?▼

You should use an automated documentation workflow when you ship changes that require updated top-level docs, new migration guides, or in-source comments explaining non-obvious design rationale to keep docs accurate and up-to-date.