Automated summary
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
How this analysis is madeExamples
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
From the file to a first result
The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.
View the source and supporting filesThis download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.
1. Download the file
Download SKILL.mdFrom the root of a test project, save the file as .skill-downloads/technical-documentation-writer-mma3jsoq/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.
Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.
mkdir -p '.skill-downloads/technical-documentation-writer-mma3jsoq' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/technical-documentation-writer-mma3jsoq/download' --output '.skill-downloads/technical-documentation-writer-mma3jsoq/SKILL.md.part' && mv '.skill-downloads/technical-documentation-writer-mma3jsoq/SKILL.md.part' '.skill-downloads/technical-documentation-writer-mma3jsoq/SKILL.md'2. Check prerequisites
Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.
Original excerpt: Prerequisites
- Access to output directories (
/docs/module-specs/,/docs/api-contracts/,/docs/adrs/) - Read access to source code for reference
The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.
3. Load the skill
After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.
Claude Code
test -f '.skill-downloads/technical-documentation-writer-mma3jsoq/SKILL.md' && test -s '.skill-downloads/technical-documentation-writer-mma3jsoq/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/amaa-documentation-writing' && cp -R '.skill-downloads/technical-documentation-writer-mma3jsoq' '.claude/skills/amaa-documentation-writing'OpenSkills
OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.
Official OpenSkills installationopenskills install './.skill-downloads/technical-documentation-writer-mma3jsoq'openskills read 'technical-documentation-writer-mma3jsoq'Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.
For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.
openskills syncManual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.
4. Try a first task
Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:
Read .skill-downloads/technical-documentation-writer-mma3jsoq/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.
Supabase Docs Authoring
Documentation
Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.
Create Architecture Decision Record
Documentation
Create a new Architecture Decision Record with sequential numbering, register it in the AgentDB graph, and link related ADRs.
Plan update with deep research
Documentation
Updates a plan document by launching parallel subagents to analyze a topic across all compiler passes, then consolidates findings into the plan doc.