Readme Maintainer

Maintain, update, and rewrite concise, publication-ready repository README files grounded in codebase facts. Use when updating README.md, refreshing installation and usage guides, verifying CLI commands, or aligning bilingual documentation.

9 stars 1 forksWriting & Content

Install

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add lingengyuan/my-skills --skill readme-maintainer
Manual install
git clone --depth 1 https://github.com/lingengyuan/my-skills.git /tmp/my-skills
mkdir -p ~/.claude/skills
cp -r /tmp/my-skills/.claude/skills/readme-maintainer ~/.claude/skills/readme-maintainer

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# README Maintainer Skill

Generate and maintain clear, verified README files directly from repository source code, build manifests, and runtime configuration. Standard Markdown is assumed knowledge.

## Workflow

1. **Locate README and files**: Identify repository root and existing `README.md`. Read the current content.
2. **Collect repository facts**: Inspect `package.json`, `Cargo.toml`, `pyproject.toml`, CLI help outputs, and configuration files. For repository-wide updates, run:
   ```bash
   bash "<skill-dir>/scripts/collect_repo_facts.sh" "<repo-path>"
   ```
3. **Verify claims against code**: Verify installation steps, prerequisites, environment variables, and CLI commands against actual repository source code. Delete stale claims and unverified statements.
4. **Structure the document**:
   - **Project Overview**: One concise sentence describing what the project does.
   - **Prerequisites & Installation**: Exact runtime versions, package managers, and setup commands.
   - **Quick Start / Basic Usage**: Minimal runnable command or code example with realistic input and output.
   - **Configuration / Key Options**: Essential configuration table or common operations.
   - **Documentation Links**: Link detailed architectural guides, API references, and development procedures to existing files instead of duplicating them.
5. **Apply publication pass**:
   - Delete meta-discourse, author reflections, and review commentary.
Read the full skill on GitHub

Details

Skill name
readme-maintainer
Path
.claude/skills/readme-maintainer/SKILL.md
License
MIT
Repo updated
14 November 2026

FAQ

What does the Readme Maintainer skill do?

Maintain, update, and rewrite concise, publication-ready repository README files grounded in codebase facts. Use when updating README.md, refreshing installation and usage guides, verifying CLI commands, or aligning bilingual documentation.

How do I install the Readme Maintainer skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add lingengyuan/my-skills --skill readme-maintainer. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Readme Maintainer popular?

It lives in lingengyuan/my-skills, which has 9 GitHub stars and 1 forks.

Related skills

Brief Output

9

lingengyuan/my-skills

精简回答、技术说明与工程文档,删除冗余信息与 AI 味表达,只保留完成任务所需的必要事实与技术决策。适用于精简输出、压缩改写、去除 AI 腔调以及全文一致性修订。

AI, LLMs & Agents

Google Go Style

9

lingengyuan/my-skills

按 Google Go Style 编写、重构或审查 Go 代码。用于命名、注释、接口、错误处理、并发、包组织与可维护性决策。

Software Development

Insight Collector

9

lingengyuan/my-skills

Analyze URLs, source code, images, technical documents, or notes, and archive reusable insights, code snippets, and architecture patterns into a knowledge base. Use when collecting knowledge, archiving technical articles, saving reusable code, or recording insights (收录, 记录一下).

Software Development

Tech Article

9

lingengyuan/my-skills

Research, draft, revise, verify, and illustrate authentic Chinese technical articles for WeChat Official Accounts or developer blogs. Use when writing technical articles, turning repositories or experiments into articles, removing AI prose patterns, or planning article illustrations.

Writing & Content

Publication Ready Docs Jev

9

lingengyuan/my-skills

撰写、精简和审查正式工程文档,用 Jev 检测冗余表达与跨章节重复。适用于发布前检查、冗余清理和质量复核。

Writing & Content

Wechat Archiver

9

lingengyuan/my-skills

Archive WeChat Official Account articles into structured knowledge assets with local Markdown, downloaded images, structured notes, and metadata. Use when archiving, indexing, or saving WeChat articles to an Obsidian vault or knowledge base.

Writing & Content

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.