# Documentation

> Use when creating, updating, or reviewing README files, technical documentation, setup instructions, architecture documentation, API documentation, or project guides.

- Skill: `daboggieman/documentation` (Agent Skill)
- Install (CLI): `npx skillmds@latest add daboggieman/documentation`
- Raw SKILL.md: https://api.skillmd.com/api/skills/daboggieman/documentation/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: Daboggieman (https://skillmd.com/u/daboggieman)
- Updated: 2026-09-21
- Page: https://skillmd.com/skills/daboggieman/documentation

---


# 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:

1. Identify affected documentation.
2. Update only relevant sections.
3. Remove obsolete instructions.
4. Check commands against the current project.
5. Ensure terminology remains consistent.

## Quality

Documentation should be:

- Accurate
- Concise
- Structured
- Searchable
- Reproducible

Never invent configuration options, commands, features, or architecture.