技能 · 编程
GitHub 文档站：README 之外的入口
项目变大后把安装/配置/API 拆到文档站（MkDocs/Docusaurus），README 只留最短上手。
适用边界：适合 SDK/工具/平台；文档站要有版本/搜索/返回仓库入口。
怎么做
- README 留：一句话/安装/最小示例/文档链接。
- 文档站分：快速开始/配置/API/FAQ/贡献。
- 加版本选择/搜索/编辑链接。
- 部署到 GitHub Pages/自定义域，检查链接。
交付前检查
- README 能 5 分钟跑通。
- 文档站有搜索/版本。
- 链接/代码示例可运行。
可复制提示词
你是开源文档工程师。输入：【项目类型/用户】=____；【现有 README】=____。请给 README/文档站分工、目录、部署和检查。不要编造 API。
相关工具
配套模板
同类技能
JSON 转 TypeScript 类型：先定可选字段
把接口返回的 JSON 样本转成 TypeScript 类型，先判断哪些字段真的可选，避免把所有字段都标成 any 或者全加问号。
查看 →正则编写：先写测试串再写表达式
先写一批应该匹配和不该匹配的样本串，再写正则，逐条跑通才收工，避免表达式只在作者想到的那一种格式上正确。
查看 →SQL 慢查询定位：先看执行计划再改索引
先看执行计划和扫描行数，再判断是缺索引、索引失效还是写法导致全表扫描，改完用同一语句复测耗时。
查看 →更新时间：2026-10-29 · 步骤是通用做法，平台/客户规则以实际页面为准；不承诺排名、过稿或收益。
跨库学习路径
按共同关键词匹配，不是随机推荐；从任务到提示词/教程/项目继续走。