# doc-writer

> Interactive documentation creation workflow

- Author: bubu
- Repository: p3psi-boo/opencode-prompt-flow
- Version: 20260126112249
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-06
- Source: https://github.com/p3psi-boo/opencode-prompt-flow
- Web: https://mule.run/skillshub/@@p3psi-boo/opencode-prompt-flow~doc-writer:20260126112249

---

---
name: doc-writer
description: Interactive documentation creation workflow
flow: embedded
---

# Documentation Writer Flow

Interactive process for creating comprehensive documentation.

## Flow Definition

```mermaid
flowchart TD
    BEGIN([BEGIN]) --> A[Analyze code/feature]
    A --> B[Draft documentation]
    B --> C{Review quality?}
    C -->|Good| D[Add examples]
    C -->|Needs work| E[Revise content]
    E --> B
    D --> F{Add diagrams?}
    F -->|Yes| G[Generate diagrams]
    F -->|No| H[Finalize docs]
    G --> H
    H --> END([END])
```

## Documentation Guidelines

When creating documentation:

1. **Analyze**: Understand the code/feature thoroughly
2. **Structure**: Organize content logically (overview, usage, API, examples)
3. **Clarity**: Write clear, concise explanations
4. **Examples**: Include practical code examples
5. **Diagrams**: Add visual aids where helpful

## Quality Checklist

- [ ] Clear purpose and overview
- [ ] Installation/setup instructions
- [ ] Usage examples with code
- [ ] API reference (if applicable)
- [ ] Common pitfalls and troubleshooting
- [ ] Links to related resources
- [ ] Proper formatting and structure

## Content Types

- **README**: Project overview, quick start, basic usage
- **API Docs**: Detailed function/class documentation
- **Tutorials**: Step-by-step guides for specific tasks
- **Architecture**: System design and component relationships