Skip to content

[P1] Create documentation-specialist agent for /document command #6

@v1truv1us

Description

@v1truv1us

Priority

P1 - High - Blocks /document command functionality

Description

Create a documentation automation agent for generating user guides, API documentation, and technical documentation.

Requirements

  • Location: codeflow-agents/generalist/documentation-specialist.yaml
  • Format: Base agent format (YAML with frontmatter)
  • Integration: Must work with /document command in command/document.md

Capabilities Needed

  • User guide generation (tutorials, how-tos, feature guides)
  • API documentation (OpenAPI/Swagger, endpoint descriptions, examples)
  • Technical documentation (architecture diagrams, system design, deployment guides)
  • Code example extraction and formatting
  • Markdown formatting and structure
  • Documentation quality validation

Acceptance Criteria

  • Agent YAML created in codeflow-agents/generalist/
  • Integrates with /document command
  • Supports multiple documentation types (user guides, API docs, technical docs)
  • Generates well-structured markdown with proper formatting
  • Includes escalation to api-documenter for complex API documentation
  • Documentation in docs/agents/documentation-specialist.md

Related

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions