技术文档如何写的清晰明了? 头大。(•̀⌄•́)
—— By Jihan
上一个我比较喜欢的技术文档书写风格示例
题目: 表述你文档核心内容
概述: 做基础背景介绍或目的介绍(默认阅读相关内容的人有相关行业背景)
内容: 按照一定逻辑进行叙述(大->小、流程顺序、时间顺序、依赖操作顺序)
其他: 引用和备注
示例:
1 | --- |
随笔写写啦 (๑`・ᴗ・´๑)
技术文档如何写的清晰明了? 头大。(•̀⌄•́)
—— By Jihan
上一个我比较喜欢的技术文档书写风格示例
题目: 表述你文档核心内容
概述: 做基础背景介绍或目的介绍(默认阅读相关内容的人有相关行业背景)
内容: 按照一定逻辑进行叙述(大->小、流程顺序、时间顺序、依赖操作顺序)
其他: 引用和备注
示例:
1 | --- |