Techwrite est un moteur de documentation de qualité professionnelle qui transforme des concepts techniques complexes en une prose exploitable et de haute précision pour les développeurs et les parties prenantes.
Installer & Télécharger
1. ClawHub CLI
Le moyen le plus rapide d'installer une compétence directement depuis le registre.
npx clawhub@latest install techwrite
2. Installation manuelle
Copiez le dossier de la compétence dans l'un de ces emplacements
~/.openclaw/skills/ <project>/skills/ Priorité : Espace de travail > Local > Intégré
3. Installation du prompt
Copiez ce prompt dans OpenClaw pour l'installer automatiquement.
Aide-moi à installer techwrite via Clawhub. Si Clawhub n'est pas installé, installe-le d'abord (npm i -g clawhub).
Vous préférez télécharger ?
Obtenez les fichiers bruts de la compétence dans une archive ZIP.
Qu'est-ce que Techwrite: Flux de travail de rédaction technique approfondie ?
Techwrite est un flux de travail spécialisé conçu pour que les agents AI produisent une documentation technique supérieure. Il déplace l'accent du simple nombre de mots vers la clarté, l'exactitude et la profondeur appropriée. En utilisant cet actif Openclaw Skills, les développeurs peuvent s'assurer que leur documentation est facile à parcourir, honnête et adaptée à des personas de lecteurs spécifiques, qu'il s'agisse de rédiger des RFCs internes, des références API publiques ou des guides de migration complexes.
Cette compétence impose un cycle de vie rigoureux en six étapes qui prévient les pièges courants de la documentation tels que les pronoms ambigus et les hypothèses cachées. Elle donne la priorité à la « tâche à accomplir » (job-to-be-done), garantissant que chaque élément de contenu mène à un résultat de succès concret où le lecteur peut agir ou décider en toute confiance sans confusion.
Cas d'utilisation de Techwrite: Flux de travail de rédaction technique approfondie
- Rédaction de références API complètes et de guides d'intégration pour de nouvelles fonctionnalités.
- Création de documents d'ingénierie à enjeux élevés comme les RFCs (Request for Comments) et les ADRs (Architecture Decision Records).
- Rédaction de runbooks faciles à parcourir, de postmortems et de documentation d'intégration pour les développeurs.
- Affinement des pages techniques existantes pour améliorer la clarté et supprimer la dette technique dans la prose.
- Génération de tableaux de dépannage et de documentation sur les cas limites pour réduire les tickets de support.
Comment fonctionne Techwrite: Flux de travail de rédaction technique approfondie
- Définition de l'audience et des objectifs: La compétence commence par identifier un seul persona de lecteur principal et une tâche spécifique à accomplir pour s'assurer que le contenu est ciblé.
- Plan et cadrage: Elle structure le document selon le principe BLUF (Bottom Line Up Front) et fait correspondre les sections au modèle mental du lecteur.
- Rédaction du contenu principal: Génère une prose précise à la voix active tout en évitant les adjectifs vagues et en définissant les termes techniques à la première utilisation.
- Exemples et cas limites: Intègre des extraits de code complets minimaux et des scénarios d'échec réalistes pour renforcer la confiance des utilisateurs.
- Révision de la clarté: Effectue une édition chirurgicale pour supprimer les pronoms ambigus et s'assurer que tous les schémas et liens sont fonctionnels et accessibles.
- Planification de la maintenance: Établit la propriété et les cadences de révision pour éviter la dégradation de la documentation au fil du temps.
Configuration de Techwrite: Flux de travail de rédaction technique approfondie
Pour intégrer Techwrite dans votre environnement, assurez-vous d'avoir installé l'exécuteur Openclaw Skills, puis ajoutez la définition techwrite à la bibliothèque de votre agent :
# Ajouter la compétence techwrite à votre dépôt local
openclaw skills add techwrite
# Déclencher le flux de travail dans votre IDE AI ou CLI
/skill techwrite "Rédiger un guide API pour notre nouveau module d'auth"
Schéma de données et taxonomie de Techwrite: Flux de travail de rédaction technique approfondie
Techwrite organise les données de documentation dans une taxonomie structurée pour maintenir la cohérence sur de grands ensembles de documents :
| Attribut | Description | Format |
|---|---|---|
| Phrase de succès | Le résultat explicite pour le lecteur | String |
| Persona | Lecteur ciblé (ex : SRE, Nouvelle recrue) | Taxonomy Key |
| BLUF | Résumé Bottom Line Up Front | Bloc Markdown |
| Étapes de procédure | Séquence numérotée d'actions | Liste ordonnée |
| Métadonnées | Versionnement, propriétaire et date de dernière révision | YAML Frontmatter |
Fonctionnalités avancées de Techwrite: Flux de travail de rédaction technique approfondie
- Support de l'itération multi-étapes : passez en toute transparence des plans bruts à une prose polie et prête à être publiée.
- Intégration de modèles : capacité d'ingérer et de suivre les guides de style organisationnels ou des modèles de documents spécifiques.
- Édition chirurgicale : affine les ébauches existantes tout en préservant la voix de l'auteur original.
- Garde-fous d'accessibilité : vérifications automatisées pour les alt-text dans les schémas et des structures d'URL stables.
- Dépréciation stratégique : conseils sur la gestion des redirections et de l'historique des pages pour les plateformes en évolution.
SKILL.md
Chargement
Compétences Openclaw associées
Serverless Deep Workflow
Un framework complet en six étapes pour concevoir, déboguer et mettre à l'échelle des charges de travail serverless résilientes sur AWS Lambda, Azure Functions et Google Cloud Functions.
OCR d'itinéraire de vol
Un outil OCR spécialisé conçu pour extraire des données structurées sur les passagers et les vols des itinéraires de billets électroniques de transport aérien.
Compétence Risk Assessment
Un cadre professionnel pour une évaluation approfondie des risques, transformant les incertitudes de projet en actions d'atténuation prioritaires et en responsabilités claires.
Flux de travail Postmortem AI Retro
Un cadre complet de postmortem sans reproche conçu pour transformer les défaillances du système en améliorations de la fiabilité exploitables.
Content Repurposer
Le Content Repurposer transforme les articles longs, les blogs et les transcriptions en publications percutantes et optimisées pour LinkedIn, Twitter et Instagram.
Intégration du SDK LeChuck de Minijuegos
Un guide d'intégration complet pour le SDK JS LeChuck de Minijuegos.com afin de gérer l'authentification des joueurs, les succès et les statistiques de jeu persistantes.
En vedette*
