Eaa Documentation Writer

Documentation Writer Skill

Overview

Technical documentation creation skill for the Documentation Writer Agent. This skill provides templates, quality standards, and workflows for producing module specifications, API contracts, architecture decision records (ADRs), and feature specifications.

Prerequisites

• Access to documentation output directories (/docs/module-specs/, /docs/api-contracts/, /docs/adrs/)
• Understanding of the 6 C's quality framework
• Read access to source code for reference

Instructions

1. Receive and parse documentation assignment
2. Gather context from existing code and specifications
3. Create document structure using appropriate template
4. Write core content following quality standards
5. Add cross-references to related documents
6. Perform quality check against 6 C's
7. Commit and report completion

Output

Table of Contents

• 1. Document Templates
• 2. Quality Standards
• 3. Writing Workflow
• 4. Operational Guidelines
• 5. Agent Interactions

Quick Reference

Document Types

Output Locations

Quality Checklist

Copy this checklist and track your progress:

• Receive and parse documentation assignment
• Gather context from existing code and specifications
• Create document structure using appropriate template
• Write core content following quality standards
• Add cross-references to related documents
• Perform quality check against 6 C's:
  • Complete - all aspects covered
  • Correct - technically accurate
  • Clear - unambiguous language
  • Consistent - same terminology throughout
  • Current - reflects latest decisions
  • Connected - cross-references to related docs
• Commit document to appropriate location
• Report completion to orchestrator

Reference Documents

Templates Reference

For all document templates, see: templates-reference.md

• 1. Module Specification Template
• 2. API Contract Template
• 3. Architecture Decision Record (ADR) Template
• 4. Input Format Examples

Quality Standards

For documentation quality criteria, see: quality-standards.md

• 1. Documentation Quality Criteria
  • 1.1 Must Be (6 C's)
  • 1.2 Must Include
  • 1.3 Must Avoid
• 2. Feature Specification Example

Writing Workflow

For step-by-step procedure, see: writing-workflow.md

• 1. Step 1: Receive and Parse Assignment
• 2. Step 2: Gather Context
• 3. Step 3: Create Document Structure
• 4. Step 4: Write Core Content
• 5. Step 5: Add Cross-References
• 6. Step 6: Quality Check
• 7. Step 7: Commit and Report

Operational Guidelines

For document management, see: operational-guidelines.md

• 1. When to Create New Documents
• 2. When to Update Existing Documents
• 3. Document Organization
• 4. Version Control
• 5. Troubleshooting

Agent Interactions

For agent coordination, see: agent-interactions.md

• 1. Upstream Agents (Receive Input From)
• 2. Downstream Agents (Provide Output To)
• 3. Peer Agents (Bidirectional)
• 4. Handoff Protocol

IRON RULE

This skill is for DOCUMENTATION ONLY. NEVER write source code.

All code examples in documentation are illustrative only.

Examples

Example 1: Write Module Specification

Assignment: Document the auth-service module

1. Read existing auth-service code
2. Use Module Specification template
3. Document:
   - Purpose and responsibilities
   - Public interfaces
   - Dependencies
   - Configuration options
4. Quality check: Complete, Correct, Clear, Consistent, Current, Connected
5. Output: /docs/module-specs/auth-service.md

Example 2: Create Architecture Decision Record

Assignment: Document decision to use PostgreSQL

1. Use ADR template
2. Document:
   - Context: Database selection needed
   - Decision: PostgreSQL chosen
   - Consequences: Pros and cons
   - Alternatives considered
3. Output: /docs/adrs/ADR-001-database-selection.md

Error Handling

Resources

• templates-reference.md - All document templates
• quality-standards.md - Documentation quality criteria
• writing-workflow.md - Step-by-step procedure
• operational-guidelines.md - Document management
• agent-interactions.md - Agent coordination

Converted and distributed by TomeVault — claim your Tome and manage your conversions.