just-vibeGeneral · apply by default
/docs
Create or update documentation from verified behavior
Use for README, guide and usage documentation from verified behavior; api-openapi owns OpenAPI contracts, release owns release notes, decision-adr owns decision records, and teach or explain answer in conversation.
Make it your own.
In Claude Code, use the slash command and add your context. In Codex, select docs from the just-vibe skill picker, then send the same brief.
Version 0.11.0 also supports /jv docs, /just-vibe docs and /jv:docs in Claude. See shortcut setup and context examples.
/just-vibe:docs Update setup instructions to match the scripts that exist today./just-vibe:docs Update docs after a flag was renamed while preserving migration guidance./just-vibe:docs Audit documentation against source with no service credentials.What the agent does
- Check documented commands, defaults and examples against the current implementation.
- Update explanations and links in source documents rather than generated copies, keeping terminology consistent, and verify executable examples where authorized.
Inputs
- documentation target, audience, and relevant code behavior.
Optional context: scope, references, constraints, successCriteria, environment, mode, budget.
Scope
- Reads
- Accurate usage, interfaces, and maintenance guidance; no invented features or changes outside the named documentation scope.
- Writes
- Apply: only the requested local changes and relevant isolated verification. Inspect/plan requests remain inspection/planning. External actions require their exact action and target in session authorization.
- Mode
- Apply; documentation target, audience, and relevant code behavior.
- Prerequisites
- Resolve the user brief and inspect the relevant project or supplied evidence. External capabilities are optional unless the selected action actually needs them.
Expected output
- Updated documentation topics with verified examples, compatibility scope, and clear labels on unverified instructions.
How the work is checked
- A documented command exists with the described behavior; deprecated behavior is not presented as current.
When to stop or clarify
- Exclude secrets and private data. Flag ambiguous product policy instead of filling it with plausible prose.
Handling missing context
- Infer
- Resolve the named files, existing scripts, current task and earlier corrections from the conversation and repository.
- Assume
- Use the narrowest interpretation that completes a reversible local task; state a consequential assumption once.
- Ask
- Ask when competing targets or incompatible success conditions would change the result; continue independent inspection first.
Technical guidance
- Evidence
- Read actual code, CLI help, examples, generated sources and supported versions.
- Method
- Update the source of truth and cross-links around observable behavior; distinguish setup instructions from evidence of successful execution.
- Pitfall
- Copying stale examples or generated output without rebuilding its source creates drift.
- Check
- Exercise runnable examples where practical, validate links and ensure documented defaults match the implementation.
Situational decisions
When examples need credentials or destructive execution: Validate syntax or a controlled substitute and label the live example unexercised.
The coding agent follows this workflow using its available tools. Installation does not grant service access or guarantee an outcome. Read the compatibility notes.