为什么有些文档的作者这么人上人

[MaMimi]

我承认他们费心费力维护文档用爱发电, 但是这个语气为什么一定要这样, 有种小学 6 年级学生和 1 年级学生讲话时的内心戏的感觉

[MaMimi]

@dqzcwxb 只是觉得没必要一再强调目标读者是小白, 想要详细就详细, 粗略直接粗略就行了, 我一开始也说了维护这种文档是吃力不讨好的事情用爱发电

[MaMimi]

@yuhangch 阿里开源图标站的

[MaMimi]

@Shura 我气急败坏了属于是

[MaMimi]

@fgwmlhdkkkw forge mod 开发文档

[AyaFrost]

有必要的话，感觉最顶 /底下强调下一次鉴于读者水平，所以 XXX 就差不多了
文内多次说读者水平怎么怎么样的话，确实不太舒服

[EPr2hh6LADQWqRVH]

又当又立，边割边骂，这种人不光 Java 有，前端更多

[eason1874]

我写文档也喜欢建议小白用户这样那样做，有的问题问烦了我会连该按哪个按键都专门写出来

当然我不会说鉴于目标读者的水平，我会说这部分内容写给小白，老用户可以跳过

[zxcslove]

可能是担心使用这玩意的人太多吧

[knightdf]

可能他已经被别人问烦了

[Phishion]

如果这个能让你感到被冒犯，那可能是你个人的原因，我觉得其实还好啦，一般气急败坏的都是配置失败的人吧，这样别人也算实话实说了，你要虚心接受。

[cmdOptionKana]

@AyaFrost
@eason1874 我猜这个写文档的人本来也是想写 “这部分专门写给小白看，老用户可以跳过”，只是这个措辞怎么说怎么容易得罪敏感的人，不写清楚吧，又怕被误认为全是必要操作。

想来想去，好像没有绝对安全不被骂的表达方式。

[advancejar]

当年学软件工程的时候老师说：写说明文档要把用户当白痴。
我觉得他实践的很好。

[blockmin]

以前开车的时候发现人真是不一样的
你以为只要吧东西放那了，想要的去拿就好了。然而不是，需要给到手里。给到手里后以为就完了，然而还不是，还需要人喂。喂到嘴里以为没事了，然而 tm 还不是，你得帮他嚼碎了喂。还有奇葩要你帮他咽。
现在我一律认为，还不会那就是不配，自己花钱找别人帮忙喂吧

[deplivesb]

难道不是么，说句实话就被你说成人上人？

[Huozy]

建议给他提个 request 怼回去

[MaMimi]

@deplivesb 我用词过激了, 其实并没有那么大的恶意和批判

[Biwood]

其实还好，至少用了很多“请”字，只是最后一句可能让一些人感到冒犯，取决于你用什么语气去读了，“人上人”的说法有点夸张

[acmore]

也不能说是人上人，臭写代码的有一个算一个哪有人上人（狗头
不过情商不高是真的，有些事就是有不同的说法，要么写长文发泄怨气，要么就从一而终当个好人。都做了那么多了，何必在这里选一个有可能不招人喜欢的说法呢。
这差不多相当于乐善好施地做好了几大锅粥，然后摆在庙前大喊 “介（鉴）于秃子不种地，赶快来吃粥罢” 么

[FrankFang128]

说事实也不行吗

[tankb52]

我曾经分享一个 markdown 转 PDF 的文档给同事。大致有以下内容：
1. 将以下命令复制后在 CMD 窗口执行
2. 打开 CMD 窗口的方法：XXXX
3. 命令本身——因为是 markdown 中的代码格式，所以有一个引用框的效果。

然后邮件发给旁边的同事看。
我就眼睁睁的看着他用鼠标指着文本一行一行的读，读到第一行后就问我：“唉下面的命令呢？”然后马上又自己回答：“哦在下面我看到了。”

当然也见过有的人，给他关键字让他百度，他发个截图给我看说百度了也没有，其实截图中第一个结果就给出了正确回答的。

所以对你的读者不要报有任何的期望。
语气确实有点不温柔。但我能理解。