home / skills / phrazzld / claude-config / log-doc-issues

log-doc-issues skill

/skills/log-doc-issues

This skill audits documentation with /check-docs, creates prioritized GitHub issues for findings, and avoids duplicates to streamline fixes.

npx playbooks add skill phrazzld/claude-config --skill log-doc-issues

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
2.6 KB
---
name: log-doc-issues
description: |
  Run /check-docs, then create GitHub issues for all findings.
  Issues are created with priority labels and structured format.
  Use /fix-docs instead if you want to fix issues immediately.
---

# /log-doc-issues

Run documentation audit and create GitHub issues for all findings.

## What This Does

1. Invoke `/check-docs` to audit documentation
2. Parse findings by priority (P0-P3)
3. Check existing issues to avoid duplicates
4. Create GitHub issues for each finding

**This is an issue-creator.** It creates work items, not fixes. Use `/fix-docs` to fix issues.

## Process

### 1. Run Primitive

Invoke `/check-docs` skill to get structured findings.

### 2. Check Existing Issues

```bash
gh issue list --state open --label "domain/docs" --limit 50
```

### 3. Create Issues

For each finding:

```bash
gh issue create \
  --title "[P1] README missing Installation section" \
  --body "$(cat <<'EOF'
## Problem
README.md exists but lacks Installation section. New developers cannot set up the project.

## Impact
- Contributor onboarding blocked
- Time wasted figuring out setup
- Potential contributors give up

## Location
`README.md`

## Suggested Fix
Run `/fix-docs` or add manually:
- Prerequisites (Node version, etc.)
- Package manager commands
- Environment setup steps

---
Created by `/log-doc-issues`
EOF
)" \
  --label "priority/p1,domain/docs,type/chore"
```

### 4. Issue Format

**Title:** `[P{0-3}] Documentation gap description`

**Labels:**
- `priority/p0` | `priority/p1` | `priority/p2` | `priority/p3`
- `domain/docs`
- `type/chore`

**Body:**
```markdown
## Problem
What documentation is missing or broken

## Impact
Who is affected (new devs, users, contributors)

## Location
File path or expected file location

## Suggested Fix
Skill to run or manual action

---
Created by `/log-doc-issues`
```

## Priority Mapping

| Gap | Priority |
|-----|----------|
| Missing README.md | P0 |
| Missing .env.example (with env vars used) | P0 |
| README missing key sections | P1 |
| Undocumented env vars | P1 |
| Missing architecture docs | P1 |
| Stale documentation (90+ days) | P2 |
| Missing CONTRIBUTING.md | P2 |
| Missing ADR directory | P2 |
| Broken links | P2 |
| Polish improvements | P3 |

## Output

After running:
```
Documentation Issues Created:
- P0: 0
- P1: 3 (README sections, env vars)
- P2: 2 (stale docs, ADRs)
- P3: 1 (link checking)

Total: 6 issues created
View: gh issue list --label domain/docs
```

## Related

- `/check-docs` - The primitive (audit only)
- `/fix-docs` - Fix documentation gaps
- `/documentation` - Full documentation workflow
- `/groom` - Full backlog grooming

Overview

This skill runs a documentation audit and creates GitHub issues for every finding. It organizes findings by priority labels (P0–P3) and produces structured issue bodies so teams can triage and assign work. Use /fix-docs when you want the tool to apply fixes instead of creating issues.

How this skill works

The skill invokes the /check-docs primitive to collect structured findings. It deduplicates against open issues labeled domain/docs, maps each finding to a priority (P0–P3), and uses the GitHub CLI to create issues with a consistent title, labels, and a suggested-fix body. It reports a summary of issues created by priority.

When to use it

  • After a documentation audit to convert findings into actionable work items
  • When you want a reproducible, labeled backlog of doc tasks for the team
  • Before a release to surface missing or stale docs that block contributors
  • When you need to track documentation debt over time
  • If you prefer manual review/triage rather than automatic fixes

Best practices

  • Run /check-docs first to produce structured findings this skill consumes
  • Keep open-issue deduplication labels consistent (domain/docs) to avoid duplicates
  • Review suggested fixes in each created issue and assign clear owners and due dates
  • Use priority labels to drive sprint planning (P0 urgent, P3 polish)
  • Run periodically (e.g., weekly) or as part of CI gates for docs hygiene

Example use cases

  • Automate creation of issues for missing README sections discovered by the audit
  • Surface undocumented environment variables as P1 issues with file locations
  • Create P0 issues when a repo is missing README.md or critical .env.example
  • Generate P2 items for stale documentation found older than 90 days
  • Produce a digest of documentation work before a contributor onboarding session

FAQ

Will this skill fix issues automatically?

No. This skill only creates GitHub issues. Use /fix-docs to apply automated fixes.

How are priorities assigned?

Findings map to P0–P3 by category (critical missing files are P0, missing key sections or env vars are P1, stale docs and structural gaps P2, and polish items P3).