documentation-generation-doc-generate
Générer une documentation de code maintenable
La documentation manuelle prend souvent du retard par rapport au code actif. Cette skill aide Claude, Codex et Claude Code à créer une documentation claire et des plans d’automatisation.
Installer avec mon Agent
Copiez cette demande dans votre Agent. Elle contient la page Skill de référence et le manifeste.
Review the Skillstore skill "documentation-generation-doc-generate" from https://skillstore.io/skills/sickn33-documentation-generation-doc-generate.md and its manifest at https://skillstore.io/api/skills/sickn33-documentation-generation-doc-generate/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.Votre Agent doit toujours présenter son plan et demander toute confirmation exigée par la politique de sécurité.
Ressources lisibles par les agents
Utilisez ces liens lorsqu’un Agent IA, un crawler ou un script a besoin d’un contexte propre au lieu de lire toute la page.
Tester
Utilisation de « documentation-generation-doc-generate ». Un service backend a besoin de documentation avant le lancement d’une API.
Résultat attendu:
- Plan de référence d’API avec groupes d’endpoints, notes d’authentification et sections d’erreurs.
- Questions ouvertes sur le versionnement, les limites de débit et les exemples de réponses.
- Étapes de validation recommandées avant publication.
Utilisation de « documentation-generation-doc-generate ». Une équipe veut une documentation d’architecture pour un système de microservices.
Résultat attendu:
- Vue d’ensemble du système avec les responsabilités des services et les flux de données.
- Plan de diagramme utilisant la notation Mermaid comme format cible.
- Risques et hypothèses nécessitant une revue par les responsables.
Utilisation de « documentation-generation-doc-generate ». Un référentiel contient des notes de configuration éparpillées et aucun guide de contribution.
Résultat attendu:
- Structure de README avec sections de configuration, paramétrage, tests et contribution.
- Liste des faits manquants à vérifier avec les mainteneurs.
- Checklist d’automatisation pour maintenir la documentation à jour.
Audit de sécurité
SûrAll 30 static findings are false positives caused by prose, Markdown formatting, placeholders, and illustrative code or workflow examples. The skill contains no executable scripts and does not directly access commands, networks, files, or environment secrets. No prompt injection or malicious intent was found.
Facteurs de risque
⚙️ Commandes externes (9)
🌐 Accès réseau (8)
📁 Accès au système de fichiers (1)
🔑 Variables d’environnement (7)
Partager et citer ce rapport
Partagez le rapport d’évaluation versionné, le badge neutre, la carte intégrable et les citations. Skillstore présente les preuves sans décider si ce Skill est sûr.
Copier le lien du rapport
https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportBadge Markdown
[](https://skillstore.io/skills/sickn33-documentation-generation-doc-generate?utm_source=security_passport_badge)Badge HTML
<a href="https://skillstore.io/skills/sickn33-documentation-generation-doc-generate?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-documentation-generation-doc-generate/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Carte intégrable
<iframe src="https://skillstore.io/embed/skills/sickn33-documentation-generation-doc-generate.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Citations académiques (APA · BibTeX · CFF)
Citation APA
sickn33. (2026). documentation-generation-doc-generate security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5Citation BibTeX
@techreport{sickn33-sickn33-documentation-generation-doc-generate-2026,
author = {sickn33},
title = {documentation-generation-doc-generate security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "documentation-generation-doc-generate security audit report (audit version 5)"
version: "unspecified"
type: report
authors:
- name: "sickn33"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5"
identifiers:
- type: other
value: "skillstore:sickn33-documentation-generation-doc-generate:audit:5"
description: "Skillstore immutable audit report identifier"
Score Skillstore
Pourquoi ce score Niveau de confiance des preuves: ÉlevéCe que vous pouvez créer
Documenter une version d’API
Créer des références d’endpoints, des notes d’authentification, des descriptions de réponses et une documentation d’API interactive à partir de définitions de routes existantes.
Expliquer l’architecture système
Transformer les services, les magasins de données et les détails de déploiement en diagrammes et en documentation concise des composants.
Standardiser la documentation de projet
Créer des sections README, configuration, guide utilisateur, contribution et dépannage avec une structure cohérente.
Essayez ces prompts
Examine ce référentiel et propose un plan de documentation. Inclue les audiences, les documents requis, les fichiers source à inspecter et les questions ouvertes.
Analyse les définitions de routes et rédige une documentation d’API. Inclue les endpoints, les paramètres, l’authentification, les erreurs, les exemples et les lacunes de validation.
Crée une documentation d’architecture pour cette application. Inclue les composants, les flux de données, les dépendances, les diagrammes, les préoccupations opérationnelles et les hypothèses.
Conçois un workflow d’automatisation de la documentation. Inclue les étapes de génération, le linting, les contrôles de couverture, les points de validation de revue, le déploiement et les risques de maintenance.
Bonnes pratiques
- Vérifier la documentation générée par rapport au code source avant publication.
- Remplacer tous les placeholders par des valeurs propres au projet.
- Masquer les secrets, les URLs internes et les détails d’implémentation sensibles.
Éviter
- Publier une documentation générée sans revue par les mainteneurs.
- Copier des commandes ou tokens placeholders dans la documentation de production.
- Documenter des détails d’infrastructure privée dans des référentiels publics.
Foire aux questions
Quels types de documentation cette skill peut-elle générer ?
Modifie-t-elle automatiquement mon code ?
Peut-elle créer une documentation OpenAPI ?
Peut-elle créer des diagrammes ?
Dois-je publier immédiatement la documentation générée ?
Fonctionne-t-elle avec Claude, Codex et Claude Code ?
Détails du développeur
Auteur
sickn33Licence
MIT
Révision Skillstore
r2
Avis de version
L’auteur n’a déclaré aucune version.
Réf
f9e2c34b4f19c7f3e6b0a1e93227b5f77cc12526
Récence de maintenance
26/07/2026
Utilisation
10 téléchargements · 108 vues
Structure de fichiers