AI Agent Skill HUB

openup-create-documentation

Generate human-readable documentation from code and artifacts

6 stars
byGermanDZ
View on GitHubInstallation ↓

Best use case

openup-create-documentation is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Generate human-readable documentation from code and artifacts

Teams using openup-create-documentation should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/openup-create-documentation/SKILL.md --create-dirs "https://raw.githubusercontent.com/GermanDZ/open-up-for-ai-agents/main/docs-eng-process/.claude-templates/skills/openup-create-documentation/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/openup-create-documentation/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How openup-create-documentation Compares

Feature / Agentopenup-create-documentationStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Generate human-readable documentation from code and artifacts

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

Related Guides

Best AI Skills for Claude

Explore the best AI skills for Claude and Claude Code across coding, research, workflow automation, documentation, and agent operations.

SKILL.md Source

# Create Documentation

Generate human-readable documentation from use cases, code, and artifacts.

## Process

### 1. Determine Documentation Type

Based on `$ARGUMENTS[doc_type]`:

| doc_type | Template | Purpose |
|----------|----------|---------|
| user-guide | user-guide-template.md | End-user documentation |
| api-reference | api-reference-template.md | API documentation |
| troubleshooting | (generated) | Common issues and solutions |
| tutorial | (generated) | Step-by-step learning |

### 2. Gather Source Material

Read relevant sources for the feature: use cases (`docs/use-cases/`), test cases (`docs/test-cases/`), design docs (`docs/design/`), and source code (`src/`). Adapt sources based on doc_type.

### 3. Generate Documentation

See type-specific files for detailed generation process:
- [user-guide.md](./user-guide.md)
- [api-reference.md](./api-reference.md)
- [troubleshooting.md](./troubleshooting.md)
- [tutorial.md](./tutorial.md)

### 4. Validate and Review

- Verify all examples are accurate
- Test code examples if applicable
- Check cross-references
- Ensure clarity for target audience

### 5. Create Documentation File

- Default path: `docs/user-guides/<feature>-<doc_type>.md`
- Custom path: Use `$ARGUMENTS[output_path]` if provided
- Link related documentation

## Example Usage

```
/openup-create-documentation doc_type: user-guide feature: user-authentication
/openup-create-documentation doc_type: api-reference feature: payment-api output_path: docs/api/
```

## Common Errors

| Error | Cause | Solution |
|-------|-------|----------|
| No use case found | Feature lacks use cases | Create use cases first |
| Code not found | Feature not implemented | Verify feature name and status |
| Template missing | Template not available | Use generic structure |

## References

- User Guide Template: `docs-eng-process/templates/user-guide-template.md`
- API Reference Template: `docs-eng-process/templates/api-reference-template.md`

## See Also

- [openup-create-use-case](../create-use-case/SKILL.md) - Create use cases first
- [openup-detail-use-case](../detail-use-case/SKILL.md) - Detail use cases for better documentation

Related Skills

openup-transition

6
from GermanDZ/open-up-for-ai-agents

Initialize and manage Transition phase activities - deploy to users

openup-tdd-workflow

6
from GermanDZ/open-up-for-ai-agents

Guide Test-Driven Development cycle adapted for AI agents with a pragmatic approach

openup-sync-spec

6
from GermanDZ/open-up-for-ai-agents

Back-propagate pure refactors to stale artifacts; classify the diff, refuse behaviour-changes, propose targeted edits for approval (read-only by default)

openup-start-iteration

6
from GermanDZ/open-up-for-ai-agents

Begin a new OpenUP iteration with proper phase context and task selection

openup-shared-vision

6
from GermanDZ/open-up-for-ai-agents

Create shared technical vision for team alignment

openup-retrospective

6
from GermanDZ/open-up-for-ai-agents

Generate iteration retrospective with feedback and action items

openup-request-input

6
from GermanDZ/open-up-for-ai-agents

Create an input request document for asynchronous stakeholder communication

openup-readiness

6
from GermanDZ/open-up-for-ai-agents

Compute the change-folder dependency DAG and print READY/BLOCKED/collision report for PM intake

openup-quick-task

6
from GermanDZ/open-up-for-ai-agents

Fast iteration mode for small changes - simplified workflow with minimal overhead

openup-plan-feature

6
from GermanDZ/open-up-for-ai-agents

Generate iteration plan and roadmap entry for a feature idea

openup-phase-review

6
from GermanDZ/open-up-for-ai-agents

Check phase completion criteria and prepare for phase review

openup-orchestrate

6
from GermanDZ/open-up-for-ai-agents

Run a full orchestrated iteration — PM decomposes the goal, delegates to specialist roles, collects outputs, and synthesizes results