Back to Skills

doc

verified

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.

View on GitHub

Marketplace

agentops-marketplace

boshu2/agentops

Plugin

docs-kit

productivity

Repository

boshu2/agentops
6stars

plugins/docs-kit/skills/doc/SKILL.md

Last Verified

January 24, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/boshu2/agentops/blob/main/plugins/docs-kit/skills/doc/SKILL.md -a claude-code --skill doc

Installation paths:

Claude
.claude/skills/doc/
Powered by add-skill CLI

Instructions

# Doc Skill

Universal documentation generation and validation for any project structure.

## Overview

Auto-detects project type (CODING, INFORMATIONAL, OPS), discovers documentable features, generates documentation, and validates coverage.

## Commands

| Command | Action |
|---------|--------|
| `discover` | Find undocumented features |
| `discover --create` | Generate stubs for undocumented |
| `gen [feature]` | Generate/update specific doc |
| `all` | Update all docs (CODING/OPS) or validate (INFORMATIONAL) |
| `sync` | Pull from canonical source |
| `coverage` | Validate docs match code |
| `coverage --create-issues` | Create tracking issues for gaps |

---

## Phase 0: Project Detection (Always First)

Run detection script to establish context:

```bash
./scripts/detect-project.sh
```

Returns JSON with type, confidence, and doc directories.

See `references/project-types.md` for signal weights and behaviors.

---

## Subcommand: discover

Find documentable features based on project type.

```bash
TYPE=$(./scripts/detect-project.sh | jq -r .type)
./scripts/discover-features.sh "$TYPE"
```

**CODING**: Finds services with endpoints, metrics, config vars (score >= 3)

**INFORMATIONAL**: Finds corpus sections, validates structure

**OPS**: Finds Helm charts, config files, runbooks

---

## Subcommand: gen

Generate or update documentation for a specific feature.

### Execution

1. Detect project type
2. Find source files (frontmatter or naming convention)
3. Extract content based on type:
   - CODING: endpoints, config, signposts, metrics
   - INFORMATIONAL: frontmatter, links, tokens
   - OPS: values.yaml, dependencies
4. Generate using templates from `references/generation-templates.md`
5. Validate output

**CODING repos**: Load `code-map-standard` skill first.

---

## Subcommand: all

Update all documentation or validate based on type.

| Type | Behavior |
|------|----------|
| CODING | Generate/update code-map docs from sources |
| INFORMATIONAL | Validate 

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
3906 chars