| name | eaa-documentation-writer |
| description | Use when writing module specs, API contracts, ADRs, or feature specs. Follows 6 C's quality framework. Trigger with technical documentation requests for modules or architecture. |
| version | 1.0.0 |
| license | Apache-2.0 |
| compatibility | Works with any codebase. Outputs to standardized documentation directories (/docs/module-specs/, /docs/api-contracts/, /docs/adrs/). Requires AI Maestro installed. |
| metadata | {"author":"Emasoft","triggers":"Create technical documentation for a module, Write API contract documentation, Document architecture decisions (ADR), Create feature specifications"} |
| context | fork |
| user-invocable | false |
| workflow-instruction | Step 7 |
| procedure | proc-create-design |
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
- 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
- Commit and report completion
Output
| Artifact | Location | Format | Contains |
|---|
| Module Specification | /docs/module-specs/<module-name>.md | Markdown | Purpose, interfaces, dependencies, configuration |
| API Contract | /docs/api-contracts/<api-name>.md | Markdown | Endpoints, request/response schemas, authentication |
| Architecture Decision Record | /docs/adrs/ADR-<NNN>-<title>.md | Markdown | Context, decision, consequences, alternatives |
| Feature Specification | /docs_dev/requirements/<feature-name>.md | Markdown | User stories, requirements, acceptance criteria |
| Process Documentation | /docs/workflows/<process-name>.md | Markdown | Workflow steps, responsibilities, tooling |
Table of Contents
-
- Document Templates
-
- Quality Standards
-
- Writing Workflow
-
- Operational Guidelines
-
- Agent Interactions