Notre avis
Compétence pour la création de documentation technique structurée (spécifications de modules, contrats d'API, ADR, spécifications fonctionnelles) selon le cadre qualité des 6 C.
Points forts
- Fournit des modèles prêts à l'emploi pour plusieurs types de documents techniques.
- Assure la qualité via le cadre des 6 C (Complet, Correct, Clair, Cohérent, Actuel, Connecté).
- S'intègre au code source pour un contexte précis et des références croisées.
- Inclut un flux de travail clair et une gestion des erreurs.
Limites
- Uniquement pour la documentation, ne peut pas générer de code source.
- Nécessite un accès en lecture au code source et aux documents de référence.
- Peut nécessiter des ajustements manuels pour des documents non standard.
Utilisez cette compétence lorsque vous devez créer ou mettre à jour des spécifications techniques, des contrats d'API, des décisions d'architecture ou des spécifications fonctionnelles.
Ne l'utilisez pas pour rédiger de la documentation utilisateur, des tutoriels ou pour écrire du code source.
Analyse de sécurité
SûrThis 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.
Aucun point d'attention détecté
Exemples
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
Generateur de Documentation API
Documentation
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
Système de formulaires de documentation typés
Documentation
Utilisez la syntaxe `(doc ...)` pour ajouter des annotations typées, des descriptions, des tâches (todo) et d'autres métadonnées directement dans le code Scheme. Les annotations sont extractibles via des commandes comme lf-todo et lf-types, et s'intègrent au vérificateur de types, où les déclarations de type dans les doc prennent le pas sur l'inférence. Idéal pour documenter les fonctions, marquer des déprécations ou lister des améliorations localisées sans recourir à un système externe.