crew-docs

Maintains changelogs, READMEs, ADRs, and API references synchronized with code changes.

2|Updated Jul 28, 2026
One-click install
npx skills add https://github.com/mbadali25/useful-claude-add-ons --skill crew-docs-mbadali25
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: crew-docs
Source: https://github.com/mbadali25/useful-claude-add-ons/tree/main/plugin/crew/skills/crew-docs
Command: npx skills add https://github.com/mbadali25/useful-claude-add-ons --skill crew-docs-mbadali25

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation drifts out of sync with code because teams either update every doc on every change (creating noise) or never update them (creating staleness). This Skill applies trigger-based rules so each document is updated only when its specific condition is met, and generates anchored API and feature references from source code. ## Core Features & Use Cases - Trigger-based doc maintenance: Each document (CHANGELOG.md, README.md, SECURITY.md, TODO.md, ADRs, runbooks) has an explicit update condition, so trivial changes like refactors and typo fixes correctly touch nothing. - Generated-block protection: Detects terraform-docs, openapi, and AUTO-GENERATED markers and redirects edits to the actual source (e.g., variable descriptions in main.tf) instead of editing output that gets overwritten. - Anchored API and feature references: Enumerates endpoints and headless features (scheduled jobs, queue consumers, feature flags) from code with file:line anchors, capturing side effects, error responses, and idempotency behavior. - Use Case: After shipping a ticket that changes a public endpoint, run the docs check to decide which documents the change should touch, add a Keep a Changelog entry written from the diff, and regenerate the API reference so its anchors still resolve. ## Quick Start Ask the assistant to check which documents this change should touch and update them accordingly.

Frequently Asked Questions about crew-docs

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

FAQPage Schema
How do I keep a CHANGELOG up to date without noise?

Add entries only for behavior users or callers can observe, written from the ticket and diff in user-facing language. Skip refactors, formatting, and internal renames, and reference the ticket id rather than commit hashes.

How to document API endpoints from source code?

Enumerate endpoints directly from code, never from existing docs, and anchor every entry to a file:line so it can be re-verified. Prioritize side effects, error responses, and idempotency behavior over signatures, which are guessable.

When should I write an Architecture Decision Record?

Write an ADR when a decision was made with a real rejected alternative, such as choosing stored procedures over application logic for batch-window constraints. ADRs are append-only; a superseded decision gets a new ADR referencing the old one.

Can I edit auto-generated documentation blocks in a README?

No. Content between markers like BEGIN_TF_DOCS or begin-openapi is regenerated on the next build, so edits are silently destroyed. Change the source instead, such as terraform variable descriptions or the main.tf header comment.

Should unfixed vulnerabilities be listed in SECURITY.md?

Never. A public SECURITY.md describing an open hole is a disclosure, not documentation. It should only cover how to report vulnerabilities, supported versions, and response times; fixed issues belong in the CHANGELOG after release.