怎么判断公司的文档写的好坏

小弟是某家互联网大厂底层程序员，在组里工作，有的时候需要写文档，但是不知道怎么判断哪些文档写的好，不知道应该模仿哪些文档。
换句话说，不知道该怎么下手把文档写好。


小弟目前的情况是，可以写文档，基本能让人明白，但是自己感觉写的就是流水账，距离好的文档差很多。


地里的大神可以分享一下经验吗？


跪谢！????????????????????????

基本上要把对方当作只会copy paste的傻B对待，不需要任何技术背景，因为你换一个领域也是这样。

主要是想清楚读者是谁，读者知道的就不用写了，不知道的则要写清楚

我一般会写个提纲。然后列出来每部分我都要写什么。具体到一个点说三句话这样。然后gpt的帮忙润色。 我觉得好文档差距不在用语而是在思维逻辑。

这个具体建议不是在论坛上说得清的。就是多练，看看别人怎么写的，还可以找个mentor。我个人感觉有phd的同事一般文档写得都不错，应该是读phd练出来的。

一句话解释就是任何人打开这份文档都能看明白需要干嘛。 技术背景不应该是让人看不懂这个文档的理由，有些人写的真的，看不懂。

如果写这个文档的人离职了，这份文档还能让人无痛读懂并且做出文档里面提到的全部内容。这个就算成功了。
公开开发者文档的话，可以看看stripe的，我目前看到最好的文档之一。