wiki-page-writer
Générer de la documentation technique avec des diagrammes Mermaid
Créer une documentation technique complète nécessite un temps considérable et un formatage cohérent. Ce skill automatise la génération de pages wiki avec des citations basées sur des preuves, des diagrammes Mermaid compatibles avec le mode sombre, et une structure compatible VitePress pour Claude, Codex et Claude Code.
Télécharger le ZIP du skill
Importer dans Claude
Allez dans Paramètres → Capacités → Skills → Importer un skill
Activez et commencez à utiliser
Tester
Utilisation de "wiki-page-writer". Document the authentication middleware in src/middleware/auth.ts
Résultat attendu:
- Page de documentation générée avec :
- - Vue d'ensemble expliquant le flux d'authentification et le modèle de sécurité
- - Diagramme de séquence montrant le cycle de vie d'authentification des requêtes
- - Tableau de composants listant les fonctions middleware avec descriptions
- - Citations de code : (src/middleware/auth.ts:45), (src/utils/jwt.ts:22), (src/config/auth.ts:8)
Utilisation de "wiki-page-writer". Create documentation for the data pipeline in src/pipeline/
Résultat attendu:
- Page de documentation générée avec :
- - Diagramme d'architecture montrant le flux de données à travers les étapes du pipeline
- - Diagramme de classes de la hiérarchie des processeurs et des interfaces
- - Détails d'implémentation avec exemples de pseudocode
- - Citations de 7 fichiers source avec numéros de ligne spécifiques
Audit de sécurité
SûrStatic analyzer detected 34 patterns (external_commands, weak_crypto, reconnaissance) but all are FALSE POSITIVES. The skill contains only markdown documentation syntax with code blocks and YAML frontmatter examples. No executable code, network calls, or cryptographic operations exist. Safe for publication.
Score de qualité
Ce que vous pouvez construire
Documenter l'architecture d'un pipeline CI/CD
Générer une documentation complète pour un pipeline CI/CD avec des diagrammes de séquence montrant les étapes de build, des citations de composants et des visualisations du flux de déploiement.
Créer de la documentation de fonctionnalité open source
Produire une documentation de fonctionnalité détaillée pour des projets open source avec des diagrammes d'architecture, des tableaux de référence API et des citations de chemins de code pour les contributeurs communautaires.
Construire un wiki technique interne
Générer des pages de documentation internes cohérentes pour les équipes d'ingénierie avec des diagrammes standardisés, des citations basées sur des preuves et une structure consultable.
Essayez ces prompts
Create a documentation page for the [component name] in [file path]. Include an overview, architecture diagram, and cite at least 3 source files with line numbers.
Write comprehensive documentation for the [feature name] feature. Analyze all files in [directory path], create 3+ Mermaid diagrams (sequence, class, and flowchart), trace the complete data flow, and cite specific code paths with file:line references.
Generate API reference documentation for [module/service]. Include endpoint tables with parameters and return types, usage examples in code blocks, and sequence diagrams showing request flows. Cite implementation files for each endpoint.
Create a migration guide from [old system] to [new system]. Include architecture comparison diagrams, component mapping tables, data flow changes, and step-by-step migration procedures with code citations from both systems.
Bonnes pratiques
- Toujours tracer les chemins de code réels avant de documenter la fonctionnalité
- Utiliser des couleurs cohérentes en mode sombre dans les diagrammes Mermaid pour la cohérence visuelle
- Citer des chemins de fichiers et numéros de ligne spécifiques pour chaque affirmation technique
Éviter
- Faire des affirmations sur la fonctionnalité sans lire le code d'implémentation réel
- Utiliser une syntaxe Mermaid qui casse le rendu en mode sombre ou la compatibilité VitePress
- Générer de la documentation factice sans citations de sources basées sur des preuves