groove-work-doc
Create a 'how does X work' documentation file for a codebase component or concept. Use $ARGUMENTS as the doc topic if provided.
- Installs
- 518
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/andreadellacorte/groove --skill groove-work-doc- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads groove-work-doc automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
groove-work-doc
Use $ARGUMENTS as the doc topic if provided.
Outcome
A structured documentation file explaining how a component, concept, or pattern works — for future agents and humans picking up the codebase.
Acceptance Criteria
Doc file contains:
- Overview: What this component/concept is and what problem it solves
- Key Files: The most important files, with a one-line role for each
- How It Works: Step-by-step explanation of the main flow or logic
- Gotchas: Non-obvious constraints, edge cases, known sharp edges
Constraints
- Sanitize topic for use as filename — strip path separators, special characters, and traversal patterns (
../) - Docs directory is always
.groove/memory/docs/ - Ensure the docs directory exists (create if missing)
- Research the codebase thoroughly before writing (use Explore agent) — docs should reference actual file paths, not generic descriptions
- Interview user if scope is ambiguous: "What's the audience — a new contributor, a future agent, or both?"
- Write doc in isolated context (use general-purpose agent)
- Verify all four required sections exist before completing
- Keep each section concise — this is a reference doc, not a tutorial
Quality Signals
- Key Files lists actual paths found in the codebase
- How It Works traces a real execution path (e.g. "user runs X → Y reads config → Z writes file")
- Gotchas surface things that are not obvious from reading the code
- Doc does not duplicate what a spec already says — link to the spec if one exists
FAQ
What does the groove-work-doc skill do?
Create a 'how does X work' documentation file for a codebase component or concept. Use $ARGUMENTS as the doc topic if provided.
How do I install groove-work-doc?
Run npx skills add https://github.com/andreadellacorte/groove --skill groove-work-doc in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/groove-work-doc/ (personal) or .claude/skills/groove-work-doc/ (project).
Which AI agents can use groove-work-doc?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is groove-work-doc safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains groove-work-doc?
It is published by andreadellacorte in andreadellacorte/groove. It has 518 recorded installs.
More from andreadellacorte/groove
groove
andreadellacorte/groove
Groove engineering workflow system. Top-level entry point. Use groove-daily-, groove-work-, groove-utilities-, groove-admin- for all workflow and admin commands.
groove-utilities-task-analyse
andreadellacorte/groove
Analyse task status and distribution across the configured backend.
groove-utilities-memory-install
andreadellacorte/groove
Set up memory backend and configuration.
groove-admin-install
andreadellacorte/groove
Install groove backends, companions, and AGENTS.md bootstrap. Run once per repo.
groove-utilities-memory-log-daily
andreadellacorte/groove
Write the daily memory log entry. Use at end of day to record what happened.
groove-utilities-task-install
andreadellacorte/groove
Set up task backend and configuration.
Popular frontend & design skills
setup-matt-pocock-skills
mattpocock/skills
Configure this repo for the engineering skills: set up its issue tracker, triage label vocabulary, and domain doc layout. Run once before first use of the other engineering skills.
frontend-design
anthropics/skills
Guidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.
hyperframes-animation
heygen-com/hyperframes
All animation knowledge for HyperFrames — atomic motion rules, multi-phase scene blueprints, scene transitions, broader motion-design techniques, AND the seven runtime adapters (GSAP default, plus Lottie, Three.js, Anime.js, CSS keyframes, Web Animations API, TypeGPU). Use for any motion or animation task: pick 2-4 rules and compose, or load a blueprint, or look up runtime-specific API (e.g. GSAP eases / Lottie player / Three.js mixer). Also covers auditing an existing composition's choreography (animation map) and 24 named text-animation effects. HyperFrames-native: single paused timeline, seek-safe, deterministic.
prototype
mattpocock/skills
Build a throwaway prototype to answer a design question. Use when the user wants to sanity-check whether a state model or logic feels right, or explore what a UI should look like.
hyperframes-core
heygen-com/hyperframes
The HyperFrames composition contract — build one renderable project. Use for composition structure, the data- timing attributes, class="clip", tracks, sub-compositions, variables, framework-owned media playback, deterministic-render rules, and validation. Read before writing composition HTML.
vercel-react-best-practices
vercel-labs/agent-skills
React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.