📄
BASIC

GitHub README Writer

READMEs built for the recruiter 30-second scan path

Ready to download

Per-user zip — knowledge base embedded, runs fully offline, no token / no internet needed

💥 你的置顶仓库就是简历附件 — 但 README 第一行写着 "my learning project",等于附件第一页写"我是新手"
项目本身不错, README 只有两行安装命令, 招聘者 10 秒关页
不知道该放什么: 功能列表写了一堆, 没人看完
中文注释和拼音变量出现在示例代码里, 自己浑然不觉

What it does

Rewrite project READMEs for the recruiter 30-second scan: hook line, demo, stack, quick start — with per-project-type structures.

Why not just use ChatGPT?

ChatGPT
ChatGPT 生成标准开源模板 (Installation/Usage/License 全家桶)
作品集 README 写手
按读者动线设计: 求职作品集的 README 是 landing page 不是文档, 30 秒动线四要素前置
ChatGPT
ChatGPT 不会追问"你解决过的最难问题"
作品集 README 写手
强制追问环节 — 这一段是面试官最爱深挖的入口, 没有它 README 没有灵魂
ChatGPT
ChatGPT 不分项目类型
作品集 README 写手
3 套结构: 作品集 (动机+亮点深挖) / 开源库 (30 秒 quick start+诚实对比) / 数据·ML (可复现+局限)
ChatGPT
ChatGPT 不查华人特有问题
作品集 README 写手
专项清查: 中式直译 ("本项目实现了…") / 拼音变量 / 中文注释 — AU 招聘者会当协作风险

See it in action

📥 输入
仓库: 一个用 Next.js + Supabase 做的二手教材交易平台 / 类型: 求职作品集 / 最难的问题: 并发下单超卖
📤 输出
# UniBooks — second-hand textbook marketplace for AU universities > Stops double-selling under concurrent checkout with row-level locking. Live demo ↓ [demo GIF 位] ## The hardest problem I solved Two students checking out the same book within 50ms used to both succeed... (招聘者最爱问的就是这段) —— 缺失物料清单 —— 1. demo GIF (用 Kap 录 15 秒, 最低成本最高回报) 2. 架构图 (mermaid 三行就够)

Use cases

  • 投简历前把置顶项目的 README 全部过一遍
  • 把"我的练习项目"改写成"它解决什么问题"
  • ML 项目补可复现段和局限段 (没有这两段的 ML README 不可信)
  • GitHub Profile README 同套规则优化

Who is this for?

应届/转码求职者
置顶 6 仓库 = 简历附件, 投递前统一体检
Bootcamp 学员
毕业项目按招聘者动线包装, 不浪费做出来的东西
开源作者
库的 quick start 和诚实对比段, 提 star 转化
📊 30 秒动线模型 + 3 类项目结构 + 中式直译清查表
结构参考 alirezarezvani/claude-skills (MIT, 338 个 skill 的工程合集) 的社区实践, 叠加 JR Academy Bootcamp 学员作品集辅导的真实经验 — "This is a simple project for learning" 这种开头, 我们在学员仓库里见过几百次, 每一次都在浪费一个好项目。

AI tool compatibility

AI ToolModeStatus
Claude CodeNative skill install (offline)
Cursor / ContinueRules / context file (offline)
Claude.aiPaste SKILL.md (offline)
ChatGPTPaste SKILL.md (offline)
Kimi / 通义 / DeepSeek / 豆包Paste SKILL.md (offline)

Install in 30 seconds

  1. Download zip (button above) — get per-user package
  2. Unzip and drag the folder into your AI tool:
    • Claude Code: ~/.claude/skills/
    • Cursor / Continue: add SKILL.md to your project rules
    • ChatGPT/Claude.ai/Kimi web: copy SKILL.md, paste into chat
  3. Type /github-readme-writer (Claude Code) or describe your task (web LLM)

FAQ

招聘者真的会看 GitHub 吗?
技术岗简历上放了链接就会被点开 — 而且点开的常是面试官本人。30 秒动线就是按"面试前 5 分钟扫一眼候选人仓库"的真实场景设计的。
项目很小/很简单, 值得写好 README 吗?
项目小不是问题, 表达小才是。同一个 todo app, "练习项目"和"解决了我自己 X 痛点的工具 + 我搞定了 Y 难题"是两个候选人。
英文不好, README 写英文会不会暴露?
skill 输出的就是地道英文 README, 你提供事实它负责表达; 中文注释清查也包含在内。比暴露英文更危险的是中式直译混着拼音变量。
在哪些 AI 工具能跑?
ChatGPT / Claude.ai / Kimi / Cursor / Claude Code 全部支持, Claude Code 里还能直接读你的仓库。
Ready to unlock?
$2 USD 单买永久解锁BASIC $8/月 起会员免费下载