Our review
Skill for creating structured technical documentation (module specs, API contracts, ADRs, feature specs) following the 6 C's quality framework.
Strengths
- Provides ready-to-use templates for several document types.
- Ensures quality through the 6 C's framework (Complete, Correct, Clear, Consistent, Current, Connected).
- Integrates with source code for accurate context and cross-references.
- Includes a clear workflow and error handling.
Limitations
- Documentation only, cannot generate source code.
- Requires read access to source code and reference documents.
- May need manual adjustments for non-standard documents.
Use this skill when creating or updating technical specifications, API contracts, architecture decision records, or feature specifications.
Do not use this skill for writing user-facing documentation, tutorials, or for writing source code.
Security analysis
SafeThis skill is solely for writing documentation (module specs, API contracts, ADRs) with no execution of commands or code. It only reads source code for reference and writes documentation files within designated directories. No risky operations are performed.
No concerns found
Examples
Document the auth-service module: read the source code, use the Module Specification template, and write its purpose, interfaces, and dependencies. Perform a 6 C quality check and output to /docs/module-specs/auth-service.md.Create an API contract for the user authentication API. Gather context from the existing codebase, use the API Contract template, detail endpoints, request/response schemas, and error codes. Quality check and save to /docs/api-contracts/user-auth-api.md.Write an ADR for migrating from a monolithic to microservices architecture. Follow the ADR template, include context, decision, consequences, and cross-references. Perform quality check and save to /docs/adrs/ADR-001-monolith-to-microservices.md.name: amaa-documentation-writing description: "Use when writing module specs, API contracts, ADRs, or feature specs following the 6 C's quality framework." context: fork user-invocable: false
Documentation Writer Skill
Overview
Technical documentation creation skill for the Documentation Writer Agent. Provides templates, quality standards, and workflows for producing module specifications, API contracts, architecture decision records (ADRs), and feature specifications. This skill is for DOCUMENTATION ONLY -- never write source code.
Prerequisites
- Access to output directories (
/docs/module-specs/,/docs/api-contracts/,/docs/adrs/) - 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 from templates-reference.md
- Write core content following quality standards
- Add cross-references to related documents
- Perform quality check against 6 C's (Complete, Correct, Clear, Consistent, Current, Connected)
- Commit document and report completion
Reference Documents
| Document | Path | Contents | |----------|------|----------| | Templates | templates-reference.md | Module spec, API contract, ADR, feature spec templates | | Quality Standards | quality-standards.md | 6 C's criteria, must-include/must-avoid rules | | Writing Workflow | writing-workflow.md | Step-by-step procedure for each document type | | Operational Guidelines | operational-guidelines.md | When to create/update docs, versioning, troubleshooting | | Agent Interactions | agent-interactions.md | Upstream/downstream agents, handoff protocol | | Op: Module Spec | op-write-module-spec.md | Detailed module spec writing procedure | | Op: API Contract | op-write-api-contract.md | Detailed API contract writing procedure | | Op: ADR | op-write-adr.md | Detailed ADR writing procedure | | Op: Feature Spec | op-write-feature-spec.md | Detailed feature spec writing procedure | | Op: Process Doc | op-write-process-doc.md | Detailed process doc writing procedure | | Op: Quality Check | op-quality-check-6c.md | 6 C's quality check procedure |
Examples
Document auth-service module: Read code → Use Module Specification template → Write purpose, interfaces, dependencies → Quality check 6 C's → Output to /docs/module-specs/auth-service.md
Error Handling
| Error | Solution | |-------|----------| | Missing context | Request source access from orchestrator | | Template not found | Use templates-reference.md | | Quality check failed | Revise content, recheck each 6 C's criterion | | Cross-reference broken | Update link or remove reference |
Output
| Artifact | Location |
|----------|----------|
| Module Specification | /docs/module-specs/<module-name>.md |
| API Contract | /docs/api-contracts/<api-name>.md |
| ADR | /docs/adrs/ADR-<NNN>-<title>.md |
| Feature Specification | /docs_dev/requirements/<feature-name>.md |
Resources
- templates-reference.md - All document templates
- quality-standards.md - Quality criteria
- writing-workflow.md - Step-by-step procedure
- agent-interactions.md - Agent coordination
API Documentation Generator
Documentation
Automatically generates OpenAPI/Swagger API documentation.
Technical Writer
Documentation
Writes clear technical documentation following top style guides.
Typed Documentation Forms System
Documentation
Add typed comments, documentation, todos, and metadata to Scheme code using `(doc ...)` forms. Doc annotations are authoritative for type inference, extracted by search commands (lf-todo, lf-types), and integrated with the type checker and LSP. Useful for annotating functions, marking deprecations, or tracking localized improvements alongside the code.