Synthèse automatique
Structure la documentation (README, RFC, guides d'onboarding, descriptions de PR) pour minimiser la charge cognitive du lecteur et du relecteur.
Points forts
- Fournit un gabarit par défaut réutilisable : réponse d'abord, quick path, details, checklist, next step
- Traite spécifiquement les docs orientées review (ce qu'il faut relire en premier, ce qui est hors scope, liens vers les PR chaînés)
- Privilégie la reconnaissance sur le rappel : tableaux, checklists, exemples et modèles plutôt que de la prose à mémoriser
- Donne des commandes concrètes pour mesurer le volume de markdown modifié et la taille d'une PR
Limites
- Ne vérifie pas que la documentation correspond au comportement réel du code, ce rôle est renvoyé à docs-alignment-ops
- Ne couvre pas le ton des commentaires humains en review, laissé à comment-writer-ops
- Fortement couplé à l'écosystème JARVIS/Gentle AI (précédence de jarvis-core, skills liées)
Quand il faut rédiger ou restructurer un README, un RFC, un guide d'onboarding ou une description de PR longue et difficile à scanner.
Quand l'objectif est uniquement de vérifier que la documentation décrit fidèlement le code actuel.
Analyse de sécurité
PrudenceLa skill no contiene comandos destructivos, exfiltración, ofuscación ni instrucciones para desactivar salvaguardas. El riesgo es moderado porque declara Bash y usa `git`/`gh`, además de permitir edición/escritura, pero los comandos mostrados son legítimos y orientados a inspeccionar cambios de documentación y metadatos de PR.
- •Declara Bash y usa comandos git/gh; `gh pr view` puede implicar acceso de red a GitHub, aunque sea de solo lectura.
- •Incluye permisos Edit/Write para documentación; es intencional, pero conviene invocarla solo en archivos de docs previstos.
Exemples
Rewrite this README so a new contributor can get productive fast: lead with the answer, add a quick path with 3 steps, move edge cases into a details table, and end with a checklist.Write the PR description for my current branch: state what changed and why, say what reviewers should look at first, list what is deliberately out of scope, and add acceptance checklists.This onboarding guide is 3000 words and hard to scan. Restructure it with progressive disclosure, short sections and signposting, keeping the happy path first.name: cognitive-doc-design-ops description: > Diseñar docs con baja carga cognitiva: lead with answer, progressive disclosure, checklists para review. Trigger: README, RFC, onboarding, descripción PR, guías densas o difíciles de escanear. license: Apache-2.0 metadata: author: JARVIS Global (patch) version: "1.0-jarvis" scope: [global] category: planning upstream: Gentleman-Programming/gentle-ai:cognitive-doc-design auto_invoke: - "Redactar o mejorar README, RFC, onboarding o guía" - "Escribir descripción de PR o notas para review" - "Doc largo, denso o difícil de escanear" triggers: cognitive doc design, baja carga cognitiva, PR description, onboarding doc, README structure, review-facing docs related-skills: - jarvis-core - docs-alignment-ops - chained-pr-ops - branch-pr-ops - writing-plans allowed-tools: [Read, Edit, Write, Glob, Grep, Bash]
JARVIS / Cursor (mandatory)
- Precedencia:
jarvis-core> esta skill. Exactitud vs código:docs-alignment-ops. - PRs encadenados: enlazar PR anterior/siguiente y "qué revisar primero" — ver
chained-pr-ops. - Comentarios humanos en review:
comment-writer-ops(tono); esta skill cubre estructura del doc. - Doc: docs/GENTLEMAN_ECOSYSTEM_INTEGRATION.md.
Cognitive Doc Design Ops
Cuándo usar
- Crear o editar documentación que alguien debe entender rápido, retener o usar durante review.
- PR descriptions, guías de contribución, arquitectura, onboarding.
- Doc que se siente largo, denso o difícil de escanear.
Cuándo NO usar: solo verificar que docs = código → docs-alignment-ops.
Patrones críticos
| Patrón | Regla | |--------|-------| | Lead with the answer | Decisión, acción u outcome primero; contexto después | | Progressive disclosure | Happy path primero; detalles, edge cases y refs después | | Chunking | Secciones pequeñas; listas planas cortas | | Signposting | Headings, labels, callouts, resúmenes para orientar al lector | | Recognition over recall | Tablas, checklists, ejemplos y plantillas > prosa memorizable | | Review empathy | El revisor verifica intent sin reconstruir toda la historia |
Forma por defecto
Usar esta estructura salvo que el repo tenga plantilla más fuerte:
# <Título orientado al outcome>
<Un párrafo: qué cambió, a quién ayuda y por qué importa.>
## Quick path
1. <Primera acción>
2. <Segunda acción>
3. <Verificación o resultado esperado>
## Details
| Topic | Decision |
|-------|----------|
| <área> | <explicación concisa> |
## Checklist
- [ ] <El lector puede confirmar esto>
- [ ] <El lector puede confirmar aquello>
## Next step
<Enlace o acción que continúa el flujo.>
PR y docs de review
Reducir burnout del revisor haciendo explícito el camino de review:
- Qué revisar primero.
- Qué queda fuera de scope a propósito.
- Enlaces al PR anterior y siguiente si la cadena es encadenada (
chained-pr-ops). - Una sección = una decisión o unidad de trabajo.
- Checklists para criterios de aceptación y verificación.
Comandos
# Markdown cambiado en la rama actual
git diff --name-only -- '*.md'
# Carga cognitiva del PR (líneas cambiadas)
gh pr view <PR_NUMBER> --json additions,deletions,changedFiles
Skills relacionadas
docs-alignment-ops— docs describen comportamiento actual del código.chained-pr-ops— PRs >400 líneas y navegación entre slices.comment-writer-ops— redactar comentarios humanos en review/issues.
Du fichier au premier essai
Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.
Consulter la source et ses fichiers annexesCe téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.
1. Télécharger le fichier
Télécharger SKILL.mdDepuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/cognitive-doc-design-ops-mrzxupuk/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.
Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.
mkdir -p '.skill-downloads/cognitive-doc-design-ops-mrzxupuk' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/cognitive-doc-design-ops-mrzxupuk/download' --output '.skill-downloads/cognitive-doc-design-ops-mrzxupuk/SKILL.md.part' && mv '.skill-downloads/cognitive-doc-design-ops-mrzxupuk/SKILL.md.part' '.skill-downloads/cognitive-doc-design-ops-mrzxupuk/SKILL.md'2. Vérifier les prérequis
Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.
Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.
Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.
3. Charger la skill
Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.
Claude Code
test -f '.skill-downloads/cognitive-doc-design-ops-mrzxupuk/SKILL.md' && test -s '.skill-downloads/cognitive-doc-design-ops-mrzxupuk/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/cognitive-doc-design-ops' && cp -R '.skill-downloads/cognitive-doc-design-ops-mrzxupuk' '.claude/skills/cognitive-doc-design-ops'Cursor
test -f '.skill-downloads/cognitive-doc-design-ops-mrzxupuk/SKILL.md' && test -s '.skill-downloads/cognitive-doc-design-ops-mrzxupuk/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/cognitive-doc-design-ops' && cp -R '.skill-downloads/cognitive-doc-design-ops-mrzxupuk' '.cursor/skills/cognitive-doc-design-ops'OpenSkills
OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.
Installation officielle d’OpenSkillsopenskills install './.skill-downloads/cognitive-doc-design-ops-mrzxupuk'openskills read 'cognitive-doc-design-ops-mrzxupuk'La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.
Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.
openskills syncMode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.
4. Faire un premier essai
Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :
Lis .skill-downloads/cognitive-doc-design-ops-mrzxupuk/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.
Rédaction de docs Supabase
Documentation
Rédigez, éditez et révisez le contenu de la documentation Supabase : guides, tutoriels, références et partiels. Suivez les guides de style et les règles de validation MDX/TOML.
Créer un enregistrement de décision d'architecture
Documentation
Créer un nouveau ADR avec numérotation séquentielle, l'enregistrer dans le graphe AgentDB et le lier aux ADR associés.
Mise à jour de plan avec recherche approfondie
Documentation
Met à jour un document de plan en lançant des sous-agents en parallèle pour analyser un sujet sur tous les passes du compilateur, puis consolide les résultats.