Daboggieman Documentation Skill
Objective
Create documentation that accurately describes the current implementation.
Evidence
Documentation must be based on:
- Current source code
- Current configuration
- Current scripts
- Current dependencies
- Current deployment setup
- Verified commands
Do not document intended behavior as if it already exists.
Setup Documentation
Installation instructions should specify:
- Prerequisites
- Required versions
- Installation commands
- Configuration
- Environment variables
- Database requirements
- Startup commands
- Verification steps
Commands
Commands must be:
- Correct for the project's environment.
- Consistent with the package manager.
- Safe to execute.
- Presented in the correct order.
API Documentation
Document:
- Endpoint
- Method
- Authentication
- Request format
- Response format
- Errors
- Important constraints
Only document behavior verified in the implementation.
Updating Documentation
When implementation changes:
- Identify affected documentation.
- Update only relevant sections.
- Remove obsolete instructions.
- Check commands against the current project.
- Ensure terminology remains consistent.
Quality
Documentation should be:
- Accurate
- Concise
- Structured
- Searchable
- Reproducible
Never invent configuration options, commands, features, or architecture.