获得徽章 6
📃 怎么写一份好文档？
我喜欢在内部知识库乱逛，有些文档写的特别好，有些则难以理解，那怎么写一份好文档？
- 面向阅读者进行整体结构组织，不要反应作者的思考路径
- 同类型文档往往有相同结构，参考语雀文档模板（见 图 2）
- 确认明确的问题，提供明确方案
- 复杂的问题要拆解成小问题，拆解路径要经得起推敲
- 如果有多种问题解决方案，罗列出来进行对比和选择
- 用标准语言表述（UML、ER），不要自创描述形式
- 画图但是不乱画，图是精华，每一幅图都有明确要表达的信息
- 信息的抽象层级要一致，不要上一段还是宏观架构，修一段是 API 返回参数错误码
- 保持文风朴素，不追求繁复，不要花里胡哨
我喜欢在内部知识库乱逛，有些文档写的特别好，有些则难以理解，那怎么写一份好文档？
- 面向阅读者进行整体结构组织，不要反应作者的思考路径
- 同类型文档往往有相同结构，参考语雀文档模板（见 图 2）
- 确认明确的问题，提供明确方案
- 复杂的问题要拆解成小问题，拆解路径要经得起推敲
- 如果有多种问题解决方案，罗列出来进行对比和选择
- 用标准语言表述（UML、ER），不要自创描述形式
- 画图但是不乱画，图是精华，每一幅图都有明确要表达的信息
- 信息的抽象层级要一致，不要上一段还是宏观架构，修一段是 API 返回参数错误码
- 保持文风朴素，不追求繁复，不要花里胡哨
展开
评论
点赞
#dbml-editor - 数据库建模 DBML 可视化编辑器，#DBML #IaC
🆕 支持 SQL 导入和导出
支持 dbml 语法检查和反馈
🖼️ 支持 Web 响应式
🌐
github.com
🆕 支持 SQL 导入和导出
支持 dbml 语法检查和反馈🖼️ 支持 Web 响应式
🌐
github.com
展开
评论
点赞
赞了这篇文章
赞了这篇文章
赞了这篇文章