Skills Guide

Optimiseur de README pour skills

VérifiéSûr

Génère un README clair, bilingue et structuré pour les dépôts GitHub de type Agent Skill, conforme aux normes agentskills.io.

Télécharger et utiliser
Spar Skills Guide Bot
DocumentationIntermédiaire
27/07/2026
Claude Code
#readme#documentation#github#agent-skills#bilingual

Recommandé pour

Claude CodeDocumentation automatiqueAutomatisation Git

Synthèse automatique

Génère ou optimise le README.md d'un dépôt GitHub contenant un Agent Skill, en suivant une structure normalisée et une liste de vérification.

Points forts

  • Commence par scanner le dépôt (frontmatter de SKILL.md, arborescence, scripts, package.json, git remote) avant d'écrire quoi que ce soit
  • Définit une stratégie de langue explicite selon la langue du SKILL.md ou la demande de l'utilisateur, avec des titres de sections bilingues
  • Applique une divulgation progressive : informations clés en tête, détails repliés dans des balises <details>
  • Fournit une checklist finale concrète (commande d'installation visible, owner/repo correct, absence de placeholders, licence, espaces entre chinois et anglais)
Quand l'utiliser

À utiliser lorsqu'il faut rédiger ou remettre à niveau le README d'un dépôt de skill pour le rendre découvrable et installable en un coup d'œil.

Quand l'éviter

À éviter pour documenter du code applicatif classique, rédiger un CHANGELOG, ou lorsque le dépôt n'est pas un skill d'agent.

Analyse de sécurité

Sûr
Score qualité82/100

The skill is purely a documentation-writing workflow: it instructs the agent to read SKILL.md, inspect directory structure, read package manifests, and check git remote to gather context, then write a README. There are no destructive commands, no network fetches, no credential handling, and no obfuscated payloads. The only 'execution' is reading local files and optionally running git remote, which is benign. The npx skills add line is presented as documentation content to place in the README, not as an instruction to execute.

Points d'attention
  • •References bundled resources (references/readme-structure.md, references/writing-principles.md, assets/example-readme.md) that may not exist in the package, which could cause partial failures but no security impact
Comment cette analyse est faite

Exemples

Optimiser un README existant
Optimise le README de ce dépôt de skill : https://github.com/Ficere/skill-readme-optimizer — je veux qu'il soit bilingue et que la commande d'installation soit visible en haut.
Écrire un README from scratch
Write a README for my agent skill repo at ~/projects/pdf-table-extractor. It has a scripts/ folder and no license yet — follow the agent skills best practices.
Audit de conformité
检查我这个 skill 仓库的 README 是否符合最佳实践，列出缺什么并直接给出改进后的完整 README。

name: skill-readme-optimizer description: > 优化 Agent Skill 类型 GitHub 仓库的 README.md。根据 agentskills.io 规范和最佳实践， 生成结构清晰、信息完整、双语友好的 README，帮助 skill 被更多用户发现和使用。 当用户提到优化 README、写 skill 的 README、改进 skill 仓库文档、 skill repo documentation、README optimization 时使用此技能。 metadata: author: Ficere version: '1.0' language: zh-CN / en

Skill README 优化器

为 Agent Skill 类型的 GitHub 仓库生成高质量的 README.md。

When to Use This Skill

当用户要求以下任务时使用：

  • 为一个 Agent Skill 仓库撰写或优化 README
  • 改进已有 skill README 的结构、内容或可读性
  • 将一个普通的 skill 文档升级为高质量的开源项目文档
  • 检查 skill README 是否符合最佳实践

Instructions

第一步：扫描项目

在编写 README 之前，先收集项目信息：

  1. 读取 SKILL.md frontmatter —— 提取 name、description、license、compatibility、metadata
  2. 检查目录结构 —— 是否有 scripts/、references/、assets/、LICENSE 等
  3. 读取 SKILL.md body —— 理解技能做什么、何时触发、核心工作流
  4. 如果有 scripts/ —— 了解是否可独立运行、依赖什么、输入输出格式
  5. 如果有 package.json 或 pyproject.toml —— 提取依赖信息
  6. 检查 git remote —— 提取 owner/repo 用于安装命令和 badge

将收集到的信息整理为结构化笔记，再进入写作。

第二步：确定语言策略

根据项目情况选择语言策略：

| 场景 | 策略 | |------|------| | SKILL.md 为中文 | 主体中文，关键术语附英文，节标题双语 | | SKILL.md 为英文 | 主体英文 | | 用户明确要求 | 按用户要求 | | 面向国际受众 | 英文为主，或中英双语 |

节标题双语格式示例：## 安装 / Install

第三步：按模板结构撰写

阅读 references/readme-structure.md 获取完整的 README 结构规范。

核心结构（按顺序）：

  1. 标题区 —— emoji + 名称（中英），一句话描述，副标题说明适用范围
  2. 生态位说明 —— 遵循 Agent Skills 开放标准，列出兼容平台
  3. 安装 —— npx skills add owner/repo 一行安装，折叠区放替代方式
  4. 使用 —— 自然语言示例（3-5个），展示真实触发场景
  5. 功能表 —— 表格形式，一眼看清能力边界
  6. 详细说明 —— 折叠区放评分细则、输入格式等深度内容
  7. 独立脚本（如有）—— 脱离 Agent 平台的用法
  8. 目录结构 —— tree 格式 + 注释
  9. 免责声明（如需）—— 适用于医疗、法律、金融、命理等敏感领域
  10. License

第四步：应用写作原则

阅读 references/writing-principles.md 获取详细的写作原则。

关键原则：

  • 一眼可装：安装命令在首屏可见，不超过一行
  • 三秒明意：标题区读完就知道这个 skill 做什么
  • 自然语言优先：使用示例展示真实对话，而非 API 调用
  • 渐进式披露：核心信息直接展示，细节用 <details> 折叠
  • 信息密度高：不写废话，每一行都有信息增量
  • badge 克制：只加真实有意义的 badge（license、兼容平台等），不堆砌装饰性 badge

第五步：自查清单

完成后对照检查：

  • [ ] 安装命令正确且在首屏可见
  • [ ] owner/repo 与实际 git remote 一致
  • [ ] 使用示例是真实可运行的自然语言
  • [ ] 功能表覆盖了 SKILL.md 中的所有核心能力
  • [ ] 目录结构与实际文件一致
  • [ ] 折叠区内容格式正确（<details> 标签）
  • [ ] 无占位符文本残留（如 {{PLACEHOLDER}}）
  • [ ] License 与 SKILL.md 或 LICENSE 文件一致
  • [ ] 中英文之间有空格（如：Agent Skill 技能）
  • [ ] 敏感领域有免责声明

Examples

输入

用户提供一个 skill 仓库路径或链接，要求优化 README。

输出

一份结构完整、信息准确、双语友好的 README.md 文件。 参考 assets/example-readme.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 annexes

Ce 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.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/skill-readme-optimizer-ms2s7c84/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/skill-readme-optimizer-ms2s7c84' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/skill-readme-optimizer-ms2s7c84/download' --output '.skill-downloads/skill-readme-optimizer-ms2s7c84/SKILL.md.part' && mv '.skill-downloads/skill-readme-optimizer-ms2s7c84/SKILL.md.part' '.skill-downloads/skill-readme-optimizer-ms2s7c84/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/skill-readme-optimizer-ms2s7c84/SKILL.md' && test -s '.skill-downloads/skill-readme-optimizer-ms2s7c84/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/skill-readme-optimizer' && cp -R '.skill-downloads/skill-readme-optimizer-ms2s7c84' '.claude/skills/skill-readme-optimizer'

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’OpenSkills
openskills install './.skill-downloads/skill-readme-optimizer-ms2s7c84'

openskills read 'skill-readme-optimizer-ms2s7c84'

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 sync

Mode 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/skill-readme-optimizer-ms2s7c84/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.

Skills similaires

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.

Claude CodeintermediateSûr 108,544
Skills Guide Bot

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.

Claude CodeintermediateSûr 69,659
Skills Guide Bot

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.

Claude CodeadvancedSûr 248,015
Skills Guide Bot