# obra-documentation

> Generates comprehensive documentation including READMEs, API docs, and inline comments

- Author: MikkohChen
- Repository: Frictionless-Labs/claude-skills
- Version: 20251222045014
- Stars: 1
- Forks: 0
- Last Updated: 2026-02-07
- Source: https://github.com/Frictionless-Labs/claude-skills
- Web: https://mule.run/skillshub/@@Frictionless-Labs/claude-skills~obra-documentation:20251222045014

---

---
name: obra-documentation
description: 'Generates comprehensive documentation including READMEs, API docs, and inline comments'
---
# obra-documentation

| Field | Value |
|-------|-------|
| **skill_id** | obra-documentation |
| **skill_name** | Documentation |
| **description** | Generates comprehensive documentation including READMEs, API docs, and inline comments |
| **repo** | obra |
| **category** | dev |
| **impl_readiness** | 84 |
| **business_value** | 87 |
| **risk_level** | low |
| **role_alignment** | Architect |
| **priority_tier** | TIER-0 |
| **effort_hours** | 0.5 |
| **dependencies** | none |
| **maturity** | active |
| **lifecycle** | candidate |
| **zip_inclusion** | ZIP-1 |

---

## Purpose

Creates and maintains technical documentation including READMEs, API references, architecture docs, and contextual code comments following best practices.

---

## Domain Alignment

| Aspect | Specification |
|--------|---------------|
| **Primary Use** | Documentation generation and maintenance |
| **Target Users** | All developers |
| **Integration Points** | Markdown, JSDoc, Sphinx, MkDocs |

---

## Triggers

| Trigger Type | Pattern |
|--------------|---------|
| **Implicit** | "document", "README", "explain" keywords |
| **Explicit** | `@doc` or `@readme` prefix |
| **Contextual** | New code or API creation context |

---

## Input/Output

| Direction | Format | Example |
|-----------|--------|---------|
| **Input** | Code or API specification | Python module with functions |
| **Output** | Documentation | README, docstrings, API reference |

---

## Safeguards

| Safeguard | Implementation |
|-----------|----------------|
| **Accuracy Check** | Doc matches actual code behavior |
| **Format Validation** | Lint markdown/docstring format |
| **Link Verification** | Check internal references valid |
| **Version Tagging** | Doc version tracks code version |

---

## Notes

- **Full Slug**: obra/superpowers
- **Source**: ChatGPT A1 Master Catalog audit
- **Batch**: ZIP-1 Batch 2 (Core Workflow)