Overview
Documentation Workflows#
Documentation Workflows provide commands to automate project documentation so AI assistants can understand the codebase faster.
Command Mapping by Platform#
| Platform | Command Style |
|---|---|
| Claude Code | /docs init, /docs update |
| Antigravity | /docs-init, /docs-update |
Why Documentation Workflows?#
The Problem#
When working with AI assistants, each new session often starts with limited context:
- AI has to re-learn project structure
- Time is spent re-explaining architecture and conventions
- Context window is consumed by catch-up
The Solution#
CafeKit Spec standardizes docs generation for core project context:
- codebase-summary.md - Codebase overview
- project-overview-pdr.md - Product requirements
- code-standards.md - Coding conventions
- system-architecture.md - System architecture
- design-guidelines.md - UI/UX guidelines
- deployment-guide.md - Deployment guide
- project-roadmap.md - Project roadmap
Plus:
- repomix-output.xml for compact AI-readable codebase context
- CLAUDE.md (root, Claude projects)
- .agent/rules/AGENTS.md (Antigravity projects)
Generated Files#
docs/
├── codebase-summary.md
├── project-overview-pdr.md
├── code-standards.md
├── system-architecture.md
├── design-guidelines.md
├── deployment-guide.md
└── project-roadmap.md
repomix-output.xml
CLAUDE.md (Claude Code projects)
.agent/rules/AGENTS.md (Antigravity projects)
Typical Usage#
First-time setup#
/docs init
# Antigravity: /docs-init
After major changes#
/docs update
# Antigravity: /docs-update
Best Practices#
Run init when:#
- New project onboarding
- First time preparing AI context
- Documentation baseline is missing
Run update when:#
- Major features merged
- Architecture/deployment changed
- Before handoff to another contributor or AI session
See Also#
/docs init- Init command details/docs update- Update command details