Rédiger un article de blog technique
Cette compétence couvre la rédaction d'articles de blog techniques sur les détails d'implémentation de tldraw.
Processus
1. Créer l'espace de travail
Créez un dossier assets pour ce sujet dans le répertoire de cette compétence :
assets/<topic>/
├── research.md # Contexte rassemblé et notes
└── draft.md # Le brouillon de l'article de blog
Utilisez un nom court en kebab-case pour le sujet (par exemple, scribbles, arrow-routing, dash-patterns).
2. Rechercher le sujet
Utilisez un subagent Explore pour rassembler toutes les informations pertinentes :
Task (subagent_type: Explore, thoroughness: very thorough)
Trouvez tout le code, la documentation et le contexte lié à [TOPIC] dans la base de code tldraw.
Cherchez :
- Les fichiers d'implémentation dans packages/editor et packages/tldraw
- Les définitions de types dans packages/tlschema
- Les exemples associés dans apps/examples
- Toute documentation existante dans apps/docs/content
- Les tests qui révèlent le comportement
- Les commentaires expliquant pourquoi les choses fonctionnent de cette façon
Pour chaque fichier pertinent, notez :
- Ce qu'il fait
- Les fonctions/classes clés
- Les détails d'implémentation intéressants
- Tous les commentaires « pourquoi » ou décisions non évidentes
Produisez un résumé complet de la façon dont [TOPIC] fonctionne. Ce document sera lu par un autre agent. Pas besoin de sur-optimiser pour la lisibilité humaine.
Enregistrez la sortie de la recherche dans assets/<topic>/research.md.
3. Identifier l'angle intéressant
Avant d'écrire, répondez à ces questions à partir de la recherche :
- Quel problème cela résout-il ? Non pas « que fait-il » mais « que se passerait-il sans lui ? »
- Qu'y a-t-il de surprenant ou contre-intuitif ? L'approche évidente qui ne fonctionne pas, ou la complexité cachée.
- Quelle est l'idée clé ? Le « aha » qui fait fonctionner la solution.
- Qu'avons-nous essayé en premier ? Tout parcours ou itération visible dans le code ou les commentaires.
Si vous ne trouvez pas d'angle intéressant, le sujet peut ne pas convenir à un article de blog technique.
4. Rédiger le brouillon
Créez assets/<topic>/draft.md en suivant la structure de blog-guide :
- Cadrer le problème — Accrochchez le lecteur avec le contexte et la tension
- Montrer l'idée — L'idée clé qui fait fonctionner la solution
- Parcourir l'implémentation — Code et explication, en augmentant la complexité
- Conclure — Où elle se trouve, les compromis, les liens vers les fichiers
Visez 800-1500 mots.
5. Auto-évaluation
Vérifiez le brouillon par rapport à la liste de contrôle blog-guide :
- [ ] Ouverture — Cadre-t-elle un problème avant de se plonger dans la solution ?
- [ ] Idée — Y a-t-il un moment « aha » ou une idée clé claire ?
- [ ] Spécificité — Est-ce fondé sur l'implémentation réelle de tldraw ?
- [ ] Code — Les exemples améliorent-ils la compréhension, plutôt que simplement montrer la syntaxe ?
- [ ] Ton — Chaleureux et personnel, mais pas verbeux ?
- [ ] Liens — Pointe vers du vrai code dans le dépôt ?
- [ ] Longueur — Profondeur appropriée pour le sujet ?
Révisez le brouillon pour combler les lacunes.
6. Sortie
Présentez le brouillon final à l'utilisateur pour révision. Le brouillon reste dans assets/<topic>/draft.md jusqu'à ce que l'utilisateur soit satisfait, à quel point il peut le déplacer vers l'emplacement approprié.
Références
- Guide de style : Voir
../shared/blog-guide.mdpour la voix, le ton et la structure. - Guide de rédaction : Voir
../shared/writing-guide.mdpour les conventions générales de rédaction.