Synthèse automatique
Rédige ou améliore un README en chinois prioritaire à partir des faits du dépôt (manifestes, scripts d'installation, code source), avec une traçabilité de chaque commande et affirmation.
Points forts
- Analyse d'abord les manifestes et la structure du dépôt avant d'écrire, ce qui limite les commandes inventées
- Table de traçabilité reliant chaque commande ou fonctionnalité à son fichier source
- Squelette de sections adapté au type de projet (pack d'outils pour agents, scripts, application web, dépôt de recherche, dépôt multilingue)
- Distingue explicitement le mode « amélioration » du mode « réécriture » et justifie son choix
Limites
- Contenu par défaut en chinois ; un README principalement anglophone nécessite des instructions supplémentaires
- S'arrête si le dépôt ne fournit aucune source de faits exploitable, plutôt que de proposer un contenu partiel
- Périmètre strictement documentaire : pas de modification du code ni d'exécution d'installation
À utiliser lorsqu'un dépôt doit être documenté, remis à quelqu'un ou publié en open source et qu'il manque un README fiable ou à jour.
À éviter si l'on cherche une documentation d'API détaillée, des diagrammes d'architecture ou une réécriture stylistique pure plutôt qu'un README de prise en main.
Analyse de sécurité
SûrThe skill is limited to reading repository metadata, documentation, and README files, and writing documentation. It explicitly forbids executing installs, modifying source code, or inventing facts. No destructive, exfiltration, or obfuscated actions are present.
Aucun point d'attention détecté
Comment cette analyse est faiteExemples
这个仓库还没有 README,请阅读 package.json 和源码后帮我生成一份中文 README,安装和用法命令必须能在文件里找到出处。我们的 README 里有些命令已经过时了,请对照 pyproject.toml 和 scripts/ 目录逐节核对,删掉不实内容并补上溯源表。We're about to open-source this repo. Improve the README for external contributors: verify the install steps against go.mod and the Makefile, and flag anything you can't confirm as TODO.name: briefbound-readme-optimization description: Use when the user asks to create, rewrite, or improve a repository README(优化 README、补仓库文档、开源准备、仓库简介), or a repo lacks a usable README before handoff or release; analyzes manifests and source facts first, then produces an audience-appropriate Chinese-first README where every command and claim is traceable. license: MIT
Briefbound Readme Optimization
目标
以仓库事实为据,产出或改进"读者不读源码即可上手"的中文优先 README。按项目类型裁剪章节,绝不编造命令、依赖或功能。
Briefbound task contract
- Context Boundary: 目标仓库的清单文件(package.json、pyproject.toml、go.mod、Cargo.toml、installer 脚本等)、目录结构、现有 README 与文档、LICENSE、git 远程与语言统计;不改代码逻辑。
- Output Contract: README.md(多语仓含 README.en.md)+ 逐节变更说明 + 事实溯源表(每条命令/功能 ↔ 来源文件)。
- Allowed Action: 读写 README 与文档文件;读取仓库任意文件取证;不执行安装、不改源码语义。
- Success Evidence: 安装与用法逐条可溯源且与清单一致;章节按类型模板完整;新读者不读源码可完成安装与首次运行。
- Stop Condition: 仓库无可用事实源、要求与事实冲突、或需要虚构功能才能满足。
- Route Out: 原任务 owner、
briefbound-diagram-design(架构配图)、briefbound-plain-talk(行文风格)、briefbound-router或 BLOCKED。
统一调用契约
- 只处理 README/文档面;不匹配时回
briefbound-router或更具体 owner,复合任务不吞其他 owner。 - 用户可见内容默认中文、保留技术字面量;Route Out 仅以 Briefbound task contract 为准;有自然闸门(需用户裁决、批准或被阻塞)时末行
下一步建议: <一个具体动作>,否则声明继续已授权工作。
章节骨架(按类型裁剪)
通用顺序:标题+一行描述 → 徽章(可选、不超过 4 枚)→ 简介(是什么/为什么,3 行内)→ 安装 → 使用(可复制命令+最小示例)→ 目录结构(仅复杂仓)→ 贡献(仅开源协作仓)→ 许可证。
- agent 技能包:加技能目录(名称+一句话)、安装命令、路由/链动入口说明(参照 codex-skills 仓库 README 模式)。
- 脚本/工具合集:每个入口脚本一段用法(命令、输入输出、一个示例);清单中不存在的脚本不写。
- 网页/应用项目:加截图位、技术栈表、本地开发步骤。
- 研究仓库:加环境、数据、复现命令、结果引用。
- 多语仓库:README.md 与 README.en.md 语义一致,中文为主版本。
证据驱动规则
- 安装命令、依赖版本、入口脚本、功能描述必须来自清单文件、installer、docstring 或源码,逐条可溯源;清单里没有的不得出现。
- 不确定的事实标注
TODO(待核实)而不是编造;徽章只用可验证项(license、语言、star)。 - 改进现有 README 先逐节对照事实:删除过时或虚构内容,保留仍然真实的用户内容与语气。
工作流
- 读清单与目录结构,判定项目类型与受众。
- 现有 README 基本可用 → 增强模式(保骨架、逐节修订);缺失或严重失真 → 重写模式。按证据自行判断,不为此询问用户,汇报时说明所用模式与理由。
- 按骨架生成内容,逐条建立溯源。
- 自查验收判据:新读者不读源码能否完成安装与首次运行;答案必须是"能"。
- 汇报遵循 plain-talk:改了什么、为什么、怎么验。
致谢
章节骨架改编自 standard-readme(MIT);工作流改编自 NASA-AMMOS/slim 的 slim-readme(Apache-2.0);证据驱动原则参考 Agensi readme-generator 的公开描述(无代码借用)。详见 references/upstream.md。
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/evidence-driven-readme-optimization-mu99johv/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/evidence-driven-readme-optimization-mu99johv' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/evidence-driven-readme-optimization-mu99johv/download' --output '.skill-downloads/evidence-driven-readme-optimization-mu99johv/SKILL.md.part' && mv '.skill-downloads/evidence-driven-readme-optimization-mu99johv/SKILL.md.part' '.skill-downloads/evidence-driven-readme-optimization-mu99johv/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/evidence-driven-readme-optimization-mu99johv/SKILL.md' && test -s '.skill-downloads/evidence-driven-readme-optimization-mu99johv/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/briefbound-readme-optimization' && cp -R '.skill-downloads/evidence-driven-readme-optimization-mu99johv' '.claude/skills/briefbound-readme-optimization'Cursor
test -f '.skill-downloads/evidence-driven-readme-optimization-mu99johv/SKILL.md' && test -s '.skill-downloads/evidence-driven-readme-optimization-mu99johv/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/briefbound-readme-optimization' && cp -R '.skill-downloads/evidence-driven-readme-optimization-mu99johv' '.cursor/skills/briefbound-readme-optimization'Codex
test -f '.skill-downloads/evidence-driven-readme-optimization-mu99johv/SKILL.md' && test -s '.skill-downloads/evidence-driven-readme-optimization-mu99johv/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/briefbound-readme-optimization' && cp -R '.skill-downloads/evidence-driven-readme-optimization-mu99johv' '.agents/skills/briefbound-readme-optimization'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/evidence-driven-readme-optimization-mu99johv'openskills read 'evidence-driven-readme-optimization-mu99johv'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/evidence-driven-readme-optimization-mu99johv/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.