Documentation Check Skill
Review code changes and determine if documentation updates or new documentation is needed.
Overview
This skill provides a comprehensive framework for maintaining documentation quality across code repositories. It ensures that all code modifications are properly reflected in documentation materials, maintaining consistency between implementation and user-facing guides.
The documentation process follows a systematic approach that evaluates code changes against existing documentation standards. This includes identifying gaps in current materials and recommending appropriate updates to support ongoing development efforts.
Usage
To utilize this skill effectively, follow these operational procedures:
Initiate Documentation Review - Begin by examining recent code modifications and their potential impact on documentation requirements.
Assess Change Scope - Evaluate whether modifications affect user-facing interfaces, internal systems, or both.
Execute Documentation Updates - Apply necessary changes to maintain alignment between code and documentation assets.
Validate Documentation Quality - Confirm that all updates meet established standards and provide clear guidance for users.
Guidelines
Operational Standards
Maintain documentation accuracy through systematic review processes. All changes should be evaluated against current documentation standards to ensure consistency and completeness.
Content Management
Documentation should reflect current code behavior and provide clear guidance for users. Regular reviews help identify areas requiring updates or enhancements.
Quality Assurance
Regular assessment of documentation materials ensures ongoing alignment with codebase evolution. This includes verification of accuracy, completeness, and usability across all documentation assets.
Examples
Documentation Review Workflow
# Example documentation check command
coder server --flag-name value
Configuration Management
> [!NOTE]
> Additional helpful information.
> [!WARNING]
> Important warning about potential issues.
> [!TIP]
> Helpful tip for users.
CLI Documentation Standards
CLI documentation in docs/reference/cli/ follows auto-generation protocols.
Changes should be coordinated with the Go code definitions to maintain
consistency across the documentation ecosystem.
Key Documentation Info
docs/manifest.json- Navigation structure; new pages MUST be added heredocs/reference/cli/*.md- Auto-generated from Go code, don't edit directly- Premium features - H1 title should include
(Premium)suffix
Coder-Specific Patterns
Callouts
Use GitHub-Flavored Markdown alerts for enhanced documentation presentation.
Code Examples
coder server --flag-name value
Documentation Verification
- Accuracy: Does documentation match current code behavior?
- Completeness: Are new features/options documented?
- Examples: Do code examples still work?
- CLI/API changes: Are new flags, endpoints, or options documented?
- Configuration: Are new environment variables or settings documented?
- Breaking changes: Are migration steps documented if needed?
- Premium features: Should docs indicate
(Premium)in the title?
Workflow
Get the code changes - Use the method provided in the prompt, or if none specified:
- For a PR:
gh pr diff <PR_NUMBER> --repo coder/coder - For local changes:
git diff mainorgit diff --staged - For a branch:
git diff main...<branch>
- For a PR:
Understand the scope - Consider what changed:
- Is this user-facing or internal?
- Does it change behavior, APIs, CLI flags, or configuration?
- Even for "internal" or "chore" changes, always verify the actual diff
Search the docs for related content in
docs/Decide what's needed:
- Do existing docs need updates to match the code?
- Is new documentation needed for undocumented features?
- Or is everything already covered?
Report findings - Use the method provided in the prompt, or if none specified, summarize findings directly
What to Check
- Accuracy: Does documentation match current code behavior?
- Completeness: Are new features/options documented?
- Examples: Do code examples still work?
- CLI/API changes: Are new flags, endpoints, or options documented?
- Configuration: Are new environment variables or settings documented?
- Breaking changes: Are migration steps documented if needed?
- Premium features: Should docs indicate
(Premium)in the title?
Key Documentation Info
docs/manifest.json- Navigation structure; new pages MUST be added heredocs/reference/cli/*.md- Auto-generated from Go code, don't edit directly- Premium features - H1 title should include
(Premium)suffix
Coder-Specific Patterns
Callouts
Use GitHub-Flavored Markdown alerts:
> [!NOTE]
> Additional helpful information.
> [!WARNING]
> Important warning about potential issues.
> [!TIP]
> Helpful tip for users.
CLI Documentation
CLI docs in docs/reference/cli/ are auto-generated. Don't suggest editing them
directly. Instead, changes should be made in the Go code that defines the CLI
commands (typically in cli/ directory).
Code Examples
Use sh for shell commands:
coder server --flag-name value