documentation-fundamentals
TRIGGERS: "is this documented?", "review my README", "check my docs", "document this", "adding comments", "updating README", "documenting API", "JSDoc", "docstring", "explaining code", "adding description", "API docs", "type annotations", README, JSDoc, docstrings, inline comments, API documentation, code comments. USE WHEN: Junior is BUILDING documentation, adding comments, or explaining code. PROVIDES: WHY-not-WHAT enforcement, README structure, JSDoc standards, comment anti-patterns. PROACTIVE: Triggers when junior mentions documenting or explaining code.
Installation
Suivez les instructions du dépôt pour votre agent. Consultez les fichiers et dépendances avant l’installation.
Voir la source ↗GuidesInstructions
Fonctions et usage
TRIGGERS: "is this documented?", "review my README", "check my docs", "document this", "adding comments", "updating README", "documenting API", "JSDoc", "docstring", "explaining code", "adding description", "API docs", "type annotations", README, JSDoc, docstrings, inline comments, API documentation, code comments. USE WHEN: Junior is BUILDING documentation, adding comments, or explaining code. PROVIDES: WHY-not-WHAT enforcement, README structure, JSDoc standards, comment anti-patterns. PROACTIVE: Triggers when junior mentions documenting or explaining code.
Démarrage rapide
Suivez les instructions du dépôt pour votre agent. Consultez les fichiers et dépendances avant l’installation.
Guides ↗Exemples
Consultez les exemples du dépôt source.
Voir la source ↗Historique source
- Date d’indexation
- 2026-01-23
- Mise à jour de l’index
- 2026-03-05
- Branch
- main
Les dates concernent ce répertoire. Consultez le dépôt pour l’historique du code.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!