内部技术文档撰写助手

先解决文档债

写模块的人往往最清楚代码怎么跑，接手的人却只能读 README.md。这份文档一旦停留在 TODO，同事就会反复追问：怎么安装、参数怎么传、常见坑在哪、出问题看哪一段。更麻烦的是内部分享：代码能跑，但讲稿没有，演示顺序和重点全靠临场发挥。

@user_af163eaa/z-tech-doc-writer 面向的是这种项目/模块级文档缺口，不是接口级 API 文档。它要求你提供代码或使用思路，再把零散信息整理成可评审的文档骨架。

核心能力与工作流

它覆盖五个动作：

• README 结构：补全项目说明、安装/运行、配置、边界等骨架。
• 用法示例：基于代码或描述整理调用方式，提醒不要写错用法。
• 架构说明：解释模块职责、关键流程和依赖关系。
• 分享稿：生成内部分享用的讲稿，而不是只给文档标题。
• FAQ 生成：把常见坑、参数歧义、排障路径列成问答。

实际使用按五步走：给代码或笔记；AI 先产出文档骨架；补用法示例；生成分享稿；最后由人审阅确认。这里的输出是草稿与审阅起点，不是自动发布的最终文档。

边界与红线

文档需要与代码同步，否则示例和参数会迅速失真。技能会提醒检查用法，但不会替代代码审查。

有两条禁止项：不要生成含密钥的文档；不要用它替代 review。若你的需求是某个端点的请求/响应说明，应选 API 接口文档生成助手；本技能更适合项目、模块和团队内部交接。