文档与 README
当变更影响他人安装、运行、配置或使用项目的方式时，应在同一变更中更新 README.md。
README 应简要涵盖以下内容：
- 项目简介（1-2 句话）。
- 依赖要求和安装步骤。
- 如何运行、测试、构建——应提供可直接复制粘贴的命令。
- 配置说明：每个环境变量的用途及示例值（绝不能使用真实的密钥）。
- 主要功能的简短使用示例。
规则：
- 仅编辑变更影响的章节，不重写整个文件。
- 验证你编写的每条命令确实可用。
- 使用英语，短句，不使用营销语言。
当功能、设置或配置发生变化时，同步更新 README.md 和项目文档。适合在添加新功能、修改安装步骤、新增环境变量或用户要求更新文档时使用。
该技能专为 AI Agent 设计，用于自动或半自动维护项目文档（特别是 README.md）与项目实际状态的一致性。在开发者添加新功能、更改配置、新增环境变量或用户主动要求更新文档时，技能会精准定位受影响的文档章节并进行针对性更新，而非重写整个文件。它重点确保 README 中包含项目简介、安装与运行步骤、可复制粘贴的命令、所有环境变量（含用途与示例值，不含真实密钥）以及主要功能的简短使用示例。该技能支持常见的 AI 编码助手平台，如 Claude Code、Cursor 和 Codex，并遵循“只修改受影响章节”、“验证每个命令的可用性”等严格规则，从而帮助开发者避免文档与代码脱节的问题。
npx skills add https://github.com/mtai0524/claude-skills/tree/HEAD/skills/docs-readmeInstalled? Explore more 生产力与协作 skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →
当变更影响他人安装、运行、配置或使用项目的方式时，应在同一变更中更新 README.md。
README 应简要涵盖以下内容：
规则：
This repo contains 4 individual skills — each has its own dedicated page.
Branch naming convention and the rule to branch before changing code on the default branch (main/master). Use when starting new work, creating a branch, or when about to edit code while on the default branch.
Update CHANGELOG.md from commits since the last tag, following Keep a Changelog. Use when the user asks to update the changelog or prepare a release.
Write git commit messages in Conventional Commits format. Use whenever creating a commit, when the user asks for a commit message, and at the end of every task that changed files (to propose the commit message).
Systematic debugging that finds and fixes the root cause instead of patching symptoms. Use for any bug, error, failing test, or unexpected behavior.
Gemini CLI one-shot prompts, summaries, generation, skills, hooks, MCP, or Gemma routing.
Fetch GitHub issues, select candidates, spawn background fix agents, open PRs, and optionally process PR review comments.
Create, edit, audit, tidy, validate, or restructure AgentSkills and SKILL.md files.
Search, install, update, sync, or publish agent skills with the ClawHub CLI and registry.
Delegate coding work to Codex, Claude Code, or OpenCode as background workers; not simple edits or read-only code lookup.
List, configure, authenticate, call, and inspect MCP servers/tools with mcporter over HTTP or stdio.