如何提升编写文档能力

[linksyi18]

java 码农一枚，三年多经验，最近新入职一家公司，被说项目文档写的很差，想问大家是如何提升文档编写能力的，有相关的数据或者文章推荐吗

[Cielsky]

功能性文档的话：简洁无二义。先概括功能，再展开论述。
其他的不清楚

[duke807]

先寫大綱，再寫內容

[leafre]

不来个文档示例，很难看出哪里写得差

[kunkunzhang]

这样问比较虚，建议拿出一些范例让大家直接帮你纠正是最好的

[liuliancao]

提下拙见
1. 了解 markdown 或者 org 等工具，代码着色，分标题，分段落，减少错别字，可以用 docsify 等
2. 代码的 doc tool ，养成写注释的习惯
3. 看看他们的文档，多和同事请教下

[vazo]

《科技文档写作实务》

[wangyzj]

有时间思考就行

[foam]

不知道楼主说的项目文档具体是哪种呢？
API 文档，能够描述清楚请求响应的参数即可；楼主说的可能是 系统设计、业务逻辑文档。

写这类专业性文档，有几点要注意的：
1. 描述清楚上下文。需要用些篇幅来介绍背景、上下文，专业术语。写的时候要代入读者，设身处地思考 TA 能不能看懂。
2. 逻辑清晰。最好列个大纲，不要想到哪写到哪。多用 1 ，2 ，3 描述步骤或者阐述观点。
3. 图文并茂。文字难以描述的，务必带上图。

有兴趣可以看看我的博客。https://foamzou.com 。
若楼主有博客也可以贴出来，我们一起学习交流。

[leonme]

金字塔原理

[dahutu]

跟着新闻五要素更改一下就能用。
是什么：文档是什么方面的
为什么：文档出现的原因是解决什么的
什么人：那些人需要文档
怎么：文档记录问题是怎么解决的
什么时间：问题什么时候出现的

然后整理一下顺序，应该就可以了

[dany813]

学习了，我文档写的也不行

[aguesuka]

试着翻译文档, 如果英语不好可以尝试已有翻译的文档, 或者熟悉语言 sdk 的注释文档