Create or update documentation with automatic validation and indexing.
Creates or updates documentation with automatic validation and indexing.
/plugin marketplace add fractary/claude-plugins/plugin install fractary-docs@fractaryclaude-haiku-4-5Create or update documentation with automatic validation and indexing.
/docs:write <doc_type> [file_path] [options]
<doc_type> - Document type (api, adr, guide, dataset, etl, testing, infrastructure, audit, architecture, standards, _untyped)[file_path] - Optional path (auto-generated if omitted)[options] - Optional flags--prompt "<instructions>" - Instructions for generating documentation from conversation context. Claude will use the current conversation plus these instructions to craft the documentation content.--skip-validation - Skip validation step--skip-index - Skip index update--batch - Write multiple documents (provide pattern)# Create API documentation
/docs:write api
# Create dataset documentation with specific path
/docs:write dataset docs/datasets/user-metrics/README.md
# Create ADR with validation skipped
/docs:write adr --skip-validation
# Batch write all API endpoints
/docs:write api docs/api/**/*.md --batch
# Generate documentation from conversation context
/docs:write api --prompt "Document the authentication endpoints we discussed, including the OAuth2 flow"
# Generate ADR capturing decision discussion
/docs:write adr --prompt "Create an ADR for the database migration strategy we decided on"
# Generate guide from implementation discussion
/docs:write guide --prompt "Write a guide covering the deployment process we walked through"
Single Document (default):
Batch Mode (--batch):
You can provide documentation content conversationally. The command will:
Using --prompt: When you provide a --prompt argument, Claude will use your instructions to guide what aspects of the conversation to capture in the documentation. This is especially useful after design discussions, implementation walkthroughs, or decision-making sessions where you want to document the outcomes.
/docs:validate - Validate existing documentation/docs:list - List documentation files/docs:audit - Audit all documentationUse the @agent-fractary-docs:docs-manager agent to handle this write operation request.