document

Write and audit technical documentation including READMEs, ADRs, changelogs, and Mermaid diagrams.

1|Updated Mar 26, 2026
One-click install
npx skills add https://github.com/arndvs/ctrlshft --skill document-arndvs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/arndvs/ctrlshft/tree/main/skills/document
Command: npx skills add https://github.com/arndvs/ctrlshft --skill document-arndvs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Codebases accumulate undocumented decisions, APIs, and data models, forcing teams to reverse-engineer intent from source. This Skill produces accurate documentation grounded in the actual code and conversation, eliminating guesswork and placeholder docs. ## Core Features & Use Cases - Multi-format documentation: Generates JSDoc, READMEs, ADRs, user guides, API references, and changelogs following established formats like Keep a Changelog. - Mermaid diagram generation: Creates flowcharts, sequence diagrams, ERDs, state diagrams, C4 diagrams, Gantt charts, and git graphs from real code structures. - Context-first workflow: Scans the conversation for signals (functions, decisions, schemas) and proposes a documentation plan before asking questions. - Use Case: After shipping an auth feature, ask it to document the work — it reads the implementation and produces a sequence diagram for the login flow, an ERD for the user model, an ADR for the token strategy, and a changelog entry. ## Quick Start Ask the agent to document the authentication flow you just built, including a sequence diagram and an ADR for the token storage decision.

Frequently Asked Questions about document

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

FAQPage Schema
How do I generate documentation from existing code?▼

Point the skill at the code and it reads the implementation before writing anything. It produces JSDoc, READMEs, ADRs, or user guides depending on what the conversation and codebase contain, never documenting from assumption.

How to create Mermaid diagrams for a codebase?▼

The skill generates Mermaid diagrams including flowcharts, sequence diagrams, ERDs, state diagrams, C4 context diagrams, Gantt charts, and git graphs. It only includes entities and steps that exist in the actual code or conversation.

When should I write an architecture decision record?▼

Write an ADR when a decision is costly to reverse, constrains future choices, or involved choosing between viable alternatives a maintainer would later question. Routine, easily-reversed choices do not need one.

Can it write a changelog from git history?▼

Yes, it reads git log or merged PRs since the last release and formats entries using the Keep a Changelog convention with Added, Changed, Fixed, and Removed sections. It never fabricates entries.

What are the limitations of AI-generated documentation?▼

Documentation is only accurate if grounded in real code, which is why this skill reads source files before writing. It refuses to document unimplemented features and removes placeholders, but you should still verify public API examples run correctly.