简诗技术文档写作

它解决的问题

工程师常常不是不会写，而是没时间把文档拆清：同一功能要给终用户、开发者和运维看，但结构、术语和可执行性完全不同。这个技能把“用户指南、操作教程、架构说明、README、发布说明、故障排查”等类型拆成模板，先确定文档类型与受众，再填内容，避免一上来写成长篇散文。

它如何工作

核心是按以下顺序推进：

• 识别文档类型：对照 references/special-types.md，确认用户指南、教程、架构文档等类型及必备章节。
• 确定受众：区分 beginner / intermediate / expert，判断角色是最终用户、开发者、管理员还是利益相关方，并明确先备知识与上下文。
• 套用结构模板：从 references/templates.md 选模板，先搭最小骨架，再补充复杂度；包含 README、发布说明、排障指南等特殊类型的要求。
• 应用写作规范：短句、主动语态、具体步骤、可扫读结构、可运行示例和用户视角；用 references/best-practices.md 做质量检查。
• 交付与维护：按 references/output-format.md 包装最终结果，附文档清单和维护说明，让后续更新有落点。

适用边界

它适合把需求转成结构化文档，但不会替你理解未提供的产品行为；输入不足时应先澄清目标读者、操作前提和边界条件。它不自动安装依赖、修改系统权限、创建持久化任务或下载内容；涉及发送、发布、删除、付款、部署等外部写入时，会先展示目标与影响并取得明确确认。凭据仅用于用户指定的官方服务，不回显、不记录或转发。