技术文档README内部分享撰写助手
> 技术名(kebab, 唯一): z-tech-doc-writer ｜ 版本: 1.0.1 ｜ 类别: 文档处理 ｜ 跨平台: 8 客户端通用
🗣️ 大白话介绍
你写了个工具/模块，但 README 永远是“TODO”，同事接手一头雾水？把代码或你脑子里怎么用的丢给它，它帮你出一份像样的文档：这东西干嘛的、怎么装、怎么调、常见坑、FAQ。内部分享要讲也直接给你演讲稿。再也不用被同事追着问“这咋跑”。
命名方案（备选）
- 推荐技术名(kebab-case, 全机唯一):
z-tech-doc-writer - 中文备选：README助手 / 项目说明 / 技术分享 / 内部文档
触发词
- 写文档
- README
- 技术分享
- 项目说明
- 技术文档
- 内部文档
核心能力
- README 结构
- 用法示例
- 架构说明
- 分享稿
- FAQ 生成
工作流程
- 给代码/笔记。
- AI 给文档骨架。
- 补用法示例。
- 生成分享稿。
- 用户审。
注意事项
- 文档需与代码同步。
- 提醒别写错用法。
红线（禁止）
- 禁止生成含密钥的文档。
- 禁止替代代码审查。
适用边界
区别于“API 接口文档生成助手”（端点/接口级），这是项目/模块级文档。
跨平台说明
本 Skill 为纯规则 / 提示词型，无数据文件、无独占 MCP / 工具依赖；错题库 / 配置均使用本技能目录相对路径（本技能无需外部数据）。支持客户端：WorkBuddy / Claude / Cursor / Codex / Windsurf / Gemini / Copilot / OpenClaw。安装与运行见 USAGE.md。
