Synthèse automatique
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é
Comment cette analyse est faiteExemples
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
Du fichier au premier essai
Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.
Consulter la source et ses fichiers annexesCe téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.
1. Télécharger le fichier
Télécharger SKILL.mdDepuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/technical-documentation-writer-mma3jsoq/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.
Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.
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. Vérifier les prérequis
Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.
Extrait original : Prerequisites
- Access to output directories (
/docs/module-specs/,/docs/api-contracts/,/docs/adrs/) - Read access to source code for reference
Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.
3. Charger la skill
Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.
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 doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.
Installation officielle d’OpenSkillsopenskills install './.skill-downloads/technical-documentation-writer-mma3jsoq'openskills read 'technical-documentation-writer-mma3jsoq'La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.
Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.
openskills syncMode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.
4. Faire un premier essai
Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :
Lis .skill-downloads/technical-documentation-writer-mma3jsoq/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.
Rédaction de docs Supabase
Documentation
Rédigez, éditez et révisez le contenu de la documentation Supabase : guides, tutoriels, références et partiels. Suivez les guides de style et les règles de validation MDX/TOML.
Créer un enregistrement de décision d'architecture
Documentation
Créer un nouveau ADR avec numérotation séquentielle, l'enregistrer dans le graphe AgentDB et le lier aux ADR associés.
Mise à jour de plan avec recherche approfondie
Documentation
Met à jour un document de plan en lançant des sous-agents en parallèle pour analyser un sujet sur tous les passes du compilateur, puis consolide les résultats.