readme-writer

readme-writer is a skill for Claude Code, Codex from guihai24/openskills. It costs 259 tokens per session (2,864 once invoked), scanned A, original, MIT.

A README-writing workflow for creating or improving the main guide to a software project. It considers both human readers and coding agents that need to understand and run the project.

In plain words
What is it for?
It helps analyse a project, choose an appropriate README structure, document installation and commands, add agent setup information, and review an existing README for quality.
Why use it?
It helps turn scattered project details into clear setup, usage, structure, and troubleshooting instructions.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: mentions CLAUDE.md; mentions AGENTS.md.

Good fit It helps analyse a project, choose an appropriate README structure, document installation and commands, add agent setup information, and review an existing README for quality.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/guihai24/openskills/readme-writer
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add guihai24/openskills --skill readme-writer
Clone the repo
git clone --depth 1 https://github.com/guihai24/openskills

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for readme-writer

README.md
[![agentmods](https://agentmods.dev/badge/skills/guihai24/openskills/readme-writer/github.svg)](https://agentmods.dev/skills/guihai24/openskills/readme-writer)
Your own site
<a href="https://agentmods.dev/skills/guihai24/openskills/readme-writer"><img src="https://agentmods.dev/badge/skills/guihai24/openskills/readme-writer/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for readme-writer

Your own site · 80×15
<a href="https://agentmods.dev/skills/guihai24/openskills/readme-writer"><img src="https://agentmods.dev/badge/skills/guihai24/openskills/readme-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 259 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,864 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00259 $0.02864
Opus 5 $0.00130 $0.01432
Sonnet 5 $0.00052 $0.00573
Haiku 4.5 $0.00026 $0.00286

Measured 2d ago against content hash c648fe35246d, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

readme-writer scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/readme-writer/SKILL.md · 140 lines

How it starts

The opening of the file, as written. The whole thing — 140 lines — stays where its author put it; the contents beside it link to each section on GitHub.

README Writer (v3.2)

生成具备 Vercel / Stripe 级顶级工业美感、深厚工程质感、并让 AI Agent 自主闭环跑通 的现代开源 README。


🎯 核心美学与设计哲学

  1. 绝对禁止 Emoji 堆砌(Zero Emoji Clutter)
    • 严禁在各级标题(######)前挂载廉价的 Unicode 表情符号(如 🚀, ⚡, 🤖, 🏗️, 🗂️, 📖, 📄 等)。这是典型的“AI 生成文本”特征,极度破坏专业度;
    • 矢量图标优先(SVG First):如需视觉引导,必须使用统一规格的单色 SVG 矢量图标(推荐尺寸 16~20px,通过 <img> 标签嵌入并保持基线对齐),或直接使用纯净优雅的纯文字标题。
  2. 现代排版与卡片美学(Bento Box & Typography)
    • 善用 HTML <table>、细分割线 --- 与引用块 > 营造高密度信息卡片,而非杂乱的无序列表堆叠;
    • 统一间距、字阶对比鲜明、留白克制。
  3. 心智推演叙事(Mental Flow)
    • 05 秒视觉锤与终端高亮模拟 ──> 530 秒痛点与竞品降维对比 ──> 30~60 秒一键 Prompt 与验证闭环 ──> 架构解耦与折叠参数。

🛠️ 工作流程

graph TD
    S1[Step 1: 深度代码取证与 8 大模态自动指纹识别] --> S2[Step 2: 模态定位与无 Emoji 纯净人设]
    S2 --> S3[Step 3: 四阶心智叙事 + 模态专属模块生成]
    S3 --> S4[Step 4: 自适应质检核验 Adaptive Checklist]
    S4 --> S5[Step 5: 输出交付 Delivery]

Step 1:深度代码取证与 8 大模态自动识别 (Code Forensics)

不要凭空脑补,先钻进代码库取证。Agent 会通过以下**代码指纹(Codebase Fingerprints)**自动判定项目模态,绝不削足适履:

模态类型 代码判定指纹 (Fingerprints) 核心展示重心
1. CLI 命令行工具 package.jsonbin 字段;Cargo.toml[[bin]];使用 clap / click / argparse 终端带耗时高亮模拟、子命令速查表、管道协作示例
2. SDK / 基础代码库 导出纯函数或类(exports / lib.rs);无前端依赖;测试用例聚焦在输入输出 30 秒 5 行上手代码块(Quick Snippet)、API 签名、性能 Benchmark
3. Web UI 组件库 包含 components/ui/tailwind.config、依赖 react/vue/radix,或有 storybook 在线 Playground 链接、组件视觉 Showcase 矩阵、原子化添加命令、A11y 与暗黑模式
4. 后台守护与基础设施 docker-compose.ymlDockerfile、监听网络端口、有 .env.example 一键 Docker Compose 拉起、环境变量配置字典、系统守护(systemd)与健康检查
5. 完整 Web / 桌面应用 包含完整前端路由(Pages/App)+ 后端 API,有数据库迁移脚本(Prisma/Drizzle) 产品界面全景截图、全栈系统拓扑图、一键云端部署按钮、多用户账号初始化
6. 宿主插件与扩展 存在 manifest.json(浏览器扩展);package.jsoncontributes(IDE 插件);raycast 元数据 应用市场安装徽章(Store Badges)、权限透明度声明、快捷键绑定表、本地解压调试指引
7. AI Agent / Skill 规则 存在 SKILL.mdmcp.jsonAGENTS.mdCLAUDE.md 显式一键 Prompt 块(Agent Launchpad)、首问预设词池(Prompt Bank)、多 Agent 兼容矩阵
8. 知识教程与精选清单 仓库全为 .md / .pdf / 静态图片,无代码构建脚本与编程语言包管理配置 多级知识架构看板、学习路径指南(按基础分级)、收录标准(Criteria)、贡献规范

Read the full file on GitHub · 140 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago Changed · +1 lines · +104 tokens per session c648fe35246d
  2. 9d ago First seen · 139 lines · 155 tokens per session scan A 20eeafecb7f7

Subscribe to this mod's changes

readme-writer is a skill published in the GitHub repository guihai24/openskills (2 stars, last pushed 3d ago), licensed MIT. It adds 259 tokens to every session and 2,864 once invoked, about $0.0013 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

insight-error-page

Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…

vercel/next.js · 83 tokens

next-cache-components-optimizer

Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…

vercel/next.js · 170 tokens

next-partial-prefetching-adoption

Turn on Partial Prefetching in a Next.js app and work through the insights it surfaces. Use when the user wants to enable or adopt Partial Prefetching, flip the partialPrefetching flag, opt routes in with export const prefetch = 'partial', audit Link prefetch={true} behavior, preserve existing prefetched UI with…

vercel/next.js · 103 tokens