Files
aiot-document/Clippings/‌‌​⁠​​​​‌​‬​⁠​⁠‌​‬‌​‬⁠​​​‬‬​‬⁠​⁠⁠​‌​​‍‍​‌​⁠⁠​✅ 写好文档检查清单 - 飞书云文档.md
lzh 0b645c72fc docs: 修复导航与架构文档中的错误引用
- 00-阅读地图:修正协作规范文档路径
- 01-总体架构设计:修正引用路径

第二轮迭代审阅中...
2026-04-07 13:59:14 +08:00

70 lines
4.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: "‌‌​⁠​​​​‌​‬​⁠​⁠‌​‬‌​‬⁠​​​‬‬​‬⁠​⁠⁠​‌​​‍‍​‌​⁠⁠​✅ 写好文档检查清单 - 飞书云文档"
source: "https://kcnluv0i5drf.feishu.cn/docx/OT0Sdf8bHoDoF3xcG5JcKwBdn6H"
author:
published:
created: 2026-03-31
description:
tags:
- "clippings"
---
- [✅ 写好文档检查清单](https://kcnluv0i5drf.feishu.cn/docx/OT0Sdf8bHoDoF3xcG5JcKwBdn6H#OT0Sdf8bHoDoF3xcG5JcKwBdn6H)
- [1\. Why - 目标](https://kcnluv0i5drf.feishu.cn/docx/OT0Sdf8bHoDoF3xcG5JcKwBdn6H#doxcnKf2C3riE0YGdP5UpHtvxgf)
- [2\. Who - 读者](https://kcnluv0i5drf.feishu.cn/docx/OT0Sdf8bHoDoF3xcG5JcKwBdn6H#doxcnwdCIJi7wGvUZddTwsgDHub)
- [3\. How - 结构](https://kcnluv0i5drf.feishu.cn/docx/OT0Sdf8bHoDoF3xcG5JcKwBdn6H#doxcnsQPK9UdOX6K03rhM7nH1Rb)
- [4\. What - 内容](https://kcnluv0i5drf.feishu.cn/docx/OT0Sdf8bHoDoF3xcG5JcKwBdn6H#doxcnpl0Fq2eQNu5Gz796WhaXSd)
- [突出重点](https://kcnluv0i5drf.feishu.cn/docx/OT0Sdf8bHoDoF3xcG5JcKwBdn6H#doxcnrRyXzkYNysGDZoEHS5vZze)
- [精简内容](https://kcnluv0i5drf.feishu.cn/docx/OT0Sdf8bHoDoF3xcG5JcKwBdn6H#doxcnID6hq53OBS2t1a2VRZksud)
- [清晰表达](https://kcnluv0i5drf.feishu.cn/docx/OT0Sdf8bHoDoF3xcG5JcKwBdn6H#doxcnxUtHrOpN3FbgvwK9gexu2b)
- [格式检查](https://kcnluv0i5drf.feishu.cn/docx/OT0Sdf8bHoDoF3xcG5JcKwBdn6H#doxcnV08YVYVcW8HxiXKWSr3PPb)
- [不断迭代](https://kcnluv0i5drf.feishu.cn/docx/OT0Sdf8bHoDoF3xcG5JcKwBdn6H#doxcnVAJW82uY18PYBnd2GxoHdb)
输入“/”快速插入内容
💡
参考最佳实践: [字节跳动优秀文档 8 大秘籍](https://www.feishu.cn/docs/doccnBYiti3wwLmVGtnAabHIAwe)
适用场景:
写文档前,参考以下问题梳理思路
写文档后,结合以下清单自查优化
Why - 目标
<table><colgroup><col width="296"> <col width="416"></colgroup><tbody><tr><td rowspan="1" colspan="1"><p>问题</p></td><td rowspan="1" colspan="1"><p>答案</p></td></tr><tr><td rowspan="1" colspan="1"><p>要解决的核心问题是什么?</p></td><td rowspan="1" colspan="1"><p></p><p>一句话说清楚核心问题</p><p></p></td></tr><tr><td rowspan="1" colspan="1"><p>我的核心观点和建议是什么?</p></td><td rowspan="1" colspan="1"><p></p><p>我的核心判断是什么?不超过 3 个要点</p><p></p></td></tr></tbody></table>
Who - 读者
<table><colgroup><col width="295"> <col width="416"></colgroup><tbody><tr><td rowspan="1" colspan="1"><p>问题</p></td><td rowspan="1" colspan="1"><p>答案</p></td></tr><tr><td rowspan="1" colspan="1"><p>目标读者都有谁?</p></td><td rowspan="1" colspan="1"><p></p><p>谁是最重要的读者</p><p></p></td></tr><tr><td rowspan="1" colspan="1"><p>Ta 们知道什么?</p></td><td rowspan="1" colspan="1"><p></p><p>有哪些背景信息,我需要让他们也提前理解?</p><p>他们可能知道哪些额外信息,可对我提供帮助?</p><p></p></td></tr><tr><td rowspan="1" colspan="1"><p>他们最关心的点是什么?</p></td><td rowspan="1" colspan="1"><p></p><p>每个角色,提炼最关心的点,如</p><p></p><p>决策者方案全面性、ROI、关键建议与风险</p><p></p><p>协作者:对业务有什么影响和收益,需要我配合做什么</p><p></p><p>信息同步对象:知道最关键的信息即可</p><p></p></td></tr></tbody></table>
How - 结构
<table><colgroup><col width="295"> <col width="414"></colgroup><tbody><tr><td rowspan="1" colspan="1"><p>问题</p></td><td rowspan="1" colspan="1"><p>答案</p></td></tr><tr><td rowspan="1" colspan="1"><p>文档整体结构是否清晰?</p></td><td rowspan="1" colspan="1"><p></p><p></p><p>参考 <a href="https://baike.baidu.com/item/%E9%87%91%E5%AD%97%E5%A1%94%E5%8E%9F%E7%90%86/14494495?fr=aladdin">金字塔原理</a> 来构建</p><p></p><p>文档目录一目了然,可以快速定位重点</p><p></p><p></p><img src="blob:https://kcnluv0i5drf.feishu.cn/013de51d-ae4e-4e31-bbe5-f6f786edbb72" width="685" height="376.75"><p></p></td></tr><tr><td rowspan="1" colspan="1"><p>关键结论是否前置?</p></td><td rowspan="1" colspan="1"><p></p><p>最关键的结论前置在前面,再展开细节</p><p></p></td></tr></tbody></table>
What - 内容
评论0
跳转至首条评论
- 字节跳动优秀文档 8 大秘籍
真诚点赞,手留余香
0 字
- 上传日志
- 联系客服
- 功能更新
- 帮助中心
- 效率指南