XW-AIOT/aiot-document
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
f827bffe91e526f812b76cb47a28e941efbea2ba
aiot-document/Clippings/‌‌​⁠​​​​‌​‬​⁠​⁠‌​‬‌​‬⁠​​​‬‬​‬⁠​⁠⁠​‌​​‍‍​‌​⁠⁠​✅ 写好文档检查清单 - 飞书云文档.md
lzh 0b645c72fc docs: 修复导航与架构文档中的错误引用 
- 00-阅读地图：修正协作规范文档路径
- 01-总体架构设计：修正引用路径

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

4.3 KiB
Raw Blame History

title, source, author, published, created, description, tags
title source author published created description tags
‌‌​⁠​​​​‌​‬​⁠​⁠‌​‬‌​‬⁠​​​‬‬​‬⁠​⁠⁠​‌​​‍‍​‌​⁠⁠​✅ 写好文档检查清单 - 飞书云文档 https://kcnluv0i5drf.feishu.cn/docx/OT0Sdf8bHoDoF3xcG5JcKwBdn6H 2026-03-31
clippings

输入“/”快速插入内容

💡

参考最佳实践： 字节跳动优秀文档 8 大秘籍

适用场景：

•

写文档前，参考以下问题梳理思路

•

写文档后，结合以下清单自查优化

Why - 目标

问题

答案

要解决的核心问题是什么？

一句话说清楚核心问题

我的核心观点和建议是什么？

我的核心判断是什么？不超过 3 个要点

Who - 读者

问题

答案

目标读者都有谁？

谁是最重要的读者

Ta 们知道什么？

有哪些背景信息，我需要让他们也提前理解？

他们可能知道哪些额外信息，可对我提供帮助？

他们最关心的点是什么？

每个角色，提炼最关心的点，如

•

决策者：方案全面性、ROI、关键建议与风险

•

协作者：对业务有什么影响和收益，需要我配合做什么

•

信息同步对象：知道最关键的信息即可

How - 结构

问题

答案

文档整体结构是否清晰？

•

参考 金字塔原理 来构建

•

文档目录一目了然，可以快速定位重点

关键结论是否前置？

最关键的结论前置在前面，再展开细节

What - 内容

评论（0）

跳转至首条评论

  • 字节跳动优秀文档 8 大秘籍

真诚点赞，手留余香

0 字

  • 上传日志

  • 联系客服

  • 功能更新

  • 帮助中心

  • 效率指南