🎯

doc

🎯Skill

from boshu2/agentops

What it does

Generates, validates, and maps documentation across different project types, identifying documentation gaps and creating comprehensive code documentation.

📦

Part of

boshu2/agentops(9 items)

doc

Installation

npxRun with npx

npx skills@latest add boshu2/agentops --all -g

npxRun with npx

npx skills@latest add boshu2/agentops -g -a codex -s '*' -y

npxRun with npx

npx skills@latest add boshu2/agentops -g -a opencode -s '*' -y

npxRun with npx

npx skills@latest add boshu2/agentops -g -a cursor -s '*' -y

npxRun with npx

npx skills@latest update

+ 5 more commands

📖 Extracted from docs: boshu2/agentops

Need more details? View full documentation on GitHub →

4Installs

AddedFeb 4, 2026

View on GitHub Back to Skills

Skill Details

SKILL.md

'This skill should be used when the user asks to "generate documentation", "validate docs", "check doc coverage", "find missing docs", "create code-map", "sync documentation", "update docs", or needs guidance on documentation generation and validation for any repository type. Triggers: doc, documentation, code-map, doc coverage, validate docs.'

Overview

# Doc Skill

YOU MUST EXECUTE THIS WORKFLOW. Do not just describe it.

Generate and validate documentation for any project.

Execution Steps

Given /doc [command] [target]:

Step 1: Detect Project Type

```bash

# Check for indicators

ls package.json pyproject.toml go.mod Cargo.toml 2>/dev/null

# Check for existing docs

ls -d docs/ doc/ documentation/ 2>/dev/null

```

Classify as:

CODING: Has source code, needs API docs
INFORMATIONAL: Primarily documentation (wiki, knowledge base)
OPS: Infrastructure, deployment, runbooks

Step 2: Execute Command

discover - Find undocumented features:

```bash

# Find public functions without docstrings (Python)

grep -r "^def " --include="*.py" | grep -v '"""' | head -20

# Find exported functions without comments (Go)

grep -r "^func [A-Z]" --include="*.go" | head -20

```

coverage - Check documentation coverage:

```bash

# Count documented vs undocumented

TOTAL=$(grep -r "^def \|^func \|^class " --include=".py" --include=".go" | wc -l)

DOCUMENTED=$(grep -r '"""' --include="*.py" | wc -l)

echo "Coverage: $DOCUMENTED / $TOTAL"

```

gen [feature] - Generate documentation:

Read the code for the feature
Understand what it does
Generate appropriate documentation
Write to docs/ directory

all - Update all documentation:

Run discover to find gaps
Generate docs for each undocumented feature
Validate existing docs are current

Step 3: Generate Documentation

When generating docs, include:

For Functions/Methods:

```markdown

function_name

Purpose: What it does

Parameters:

param1 (type): Description
param2 (type): Description

Returns: What it returns

Example:

```python

result = function_name(arg1, arg2)

```

Notes: Any important caveats

```

For Classes:

```markdown

ClassName

Purpose: What this class represents

Attributes:

attr1: Description
attr2: Description

Methods:

method1(): What it does
method2(): What it does

Usage:

```python

obj = ClassName()

obj.method1()

```

Step 4: Create Code-Map (if requested)

Write to: docs/code-map/

```markdown

# Code Map:

Overview

Directory Structure

```

src/

├── module1/ # Purpose

├── module2/ # Purpose

└── utils/ # Shared utilities

```

Key Components

Module 1

Purpose: What it does
Entry point: main.py
Key files: handler.py, models.py

Module 2

...

Data Flow

Dependencies

```

Step 5: Validate Documentation

Check for:

Out-of-date docs (code changed, docs didn't)
Missing sections (no examples, no parameters)
Broken links
Inconsistent formatting

Step 6: Write Report

Write to: .agents/doc/YYYY-MM-DD-.md

```markdown

# Documentation Report:

Date: YYYY-MM-DD

Project Type:

Coverage

Total documentable items:
Documented:
Coverage: %

Generated

Gaps Found

Validation Issues

Next Steps

[ ] Document remaining gaps
[ ] Fix validation issues

```

Step 7: Report to User

Tell the user:

Documentation coverage percentage
Docs generated/updated
Gaps remaining
Location of report

Key Rules

Detect project type first - approach varies
Generate meaningful docs - not just stubs
Include examples - always show usage
Validate existing - docs can go stale
Write the report - track coverage over time

Commands Summary

| Command | Action |

|---------|--------|

| discover | Find undocumented features |

| coverage | Check documentation coverage |

| gen [feature] | Generate docs for specific feature |

| all | Update all documentation |

| validate | Check docs match code |

More from this repository8

Skill

Skill

Skill

Skill

Skill

Traces design decisions and concepts through session history, handoffs, and git repositories.

🎯

inbox🎯Skill

Monitors Agent Mail inbox, retrieving pending messages, help requests, and recent task completions across agents.

🎯

shared🎯Skill

Provides reference documents for coordinating distributed mode skills across the Claude Code system.