DOCUMENTS / DOC—003
文档 · 2026-05-30
技术写作发布检查清单
发布前快速检查事实、代码、链接与窄屏阅读体验。
内容
- 标题是否准确表达文章真正回答的问题?
- 开头是否说明读者为什么需要继续读?
- 关键结论是否有证据、示例或可复现路径?
- 是否区分事实、经验和推测?
代码
- 示例是否能独立运行?
- 是否移除了密钥、内部地址和个人信息?
- 依赖版本是否明确?
- 代码块在窄屏上是否可以阅读?
发布
- 描述、规范链接与社交分享信息是否完整?
- 标题层级是否连续?
- 链接是否可访问?
- 移动端是否存在横向滚动?
- 订阅源与站点地图是否包含新文章?