美国最大的论坛 Reddit，最近有一个热帖, 摘取一部分内容：
- 优秀经理的品质与优秀工程师的许多品质相同。
- 好的代码是初级工程师可以理解的代码。伟大的代码可以被第一年的 CS 新生理解。最好的代码是根本没有代码。
- 如果我发现自己认为自己是房间里最聪明的人，那么就该离开了。
- 我们应该雇佣更多的实习生，他们很棒。那些精力充沛的小家伙用他们的想法乱搞。如果他们可以质疑或批评某事，那就更好了。我喜欢实习生。
- 不要遇见你的英雄。我花了 5000 美元参加了我的一位英雄的课程。他是一个才华横溢的人，但最后我意识到他和我们其他人一样在做事时正在编造。
- 技术栈很重要。好的，我只是说技术堆栈无关紧要，但请听我说。如果您听到 Python 开发与 C++
开发，您会想到非常不同的事情，对吗？那是因为某些工具确实擅长某些工作。如果您不确定自己想要做什么，请使用
Java。这是一种糟糕的编程语言，几乎无所不能。 - 在家工作是山雀。但缺乏白板很糟糕。
- 管理者的权力比你想象的要少。动力少多了。如果你有事，为什么 XYZ 经理不解雇某人，那是因为他们不能。
- 善待每一个人。不是因为它会帮助你的事业，而是因为善良本身就是有益的。
- 如果上个月我没有从初级工程师或实习生那里学到一些东西，我就没有注意。
- 我工作过的最聪明的人是数学博士。我从那个人身上学到了很多。我希望他过得很好。
- 你知道成为软件工程师最好的部分是什么吗？您可以结识和您想法相同的人并与之交谈。不一定有相同的兴趣，如体育和电视节目等。但是他们以与您思考问题相同的方式思考问题。这很酷。
- 技术领域的女性不够多。真是个烂行业。这需要改变。我一直在努力为我们组织中的女性工程师提供更多鼓励和帮助，但我不知道还能做什么。
- 成为一名优秀的工程师意味着了解最佳实践。成为高级工程师意味着知道何时打破最佳实践。
- 如果人们试图将责任归咎于错误或中断，那么是时候继续前进了。
- 同样，我有幸在其手下工作的最优秀的领导者竭尽全力支持我的观点，并向我解释“与我的观点相冲突的其他观点”。我正在努力成为像他们一样的人。
- 做我喜欢的事情并不重要。做我不讨厌的事情更重要。
- 我越接近产品，我就越接近推动收入增长，无论我的工作技术性如何，我都感到越有价值。即使是最先进的公司也是如此。
- 即使我在所有 Windows 中工作，Linux 也很重要。为什么？因为我最终在 Linux 工作。
- 并非所有伟大的工作都在硅谷。但很多都是。
- 应该有一种,最好只有一种,明显的方法来做到这一点。
- 与聪明的工程师一起工作使我成为一个更好的编码员。与聪明的非技术同事一起工作使我成为一名更好的工程师。
- 不要把时间花在朝九晚五之外的工作上。除非你想要，因为你有一个轰轰烈烈的项目并且你处于最佳状态。那玩意儿太棒了
- 注释、文档和文档字符串几乎与代码一样重要，如果您不能花时间对某个函数进行注释，那么您就不应该编写该函数。打我。
- 请为您的变量命名并合理地将它们放在范围内。我讨厌深奥的废话
- 请善待新编码人员或尝试编码或学习编码的人，你能为他们和你自己以及整个行业做的最好的事情就是做人，对人好。这适用于伟大的互联网上的老板或员工或同事或随机陌生人。只要乖一点。毕竟，这些都是像你一样的人。
- 对于正在记录的主题，请考虑 Cotton-Eye Joe：它来自哪里（输入方面,它去了哪里（输出方面）
- 为需要用户输入字符串的事情提供示例，一个具有结构，一个具有输入的实际实例，也很棒。就其他示例而言，我尝试考虑客户最有可能使用和合并的场景。
- 提供足够大的屏幕截图来显示上下文，以便清楚使用程序的哪个部分，或使用文本来解释源
- 从头开始。我的意思是，甚至在你写第一行之前，你应该有一个基本的流程图，说明你希望事情看起来如何。
- IT 领域的年龄歧视是真实存在的。通过继续学习和更新您的技能，尤其是写作、演讲和指导等软技能，做好准备。
- 使用小词/短句。你的句子越长，人们就越难消化。难懂的词只会让人产生距离感。
- 文档很难写。为一个目标编写好的文档需要几天时间。没有人会理解写作有多难
- 图片有帮助。有些人用图片更好地处理事情。我不知道为什么，但他们知道
- 文档没有尽头。无论你认为最终草案是什么，它都不是。你会错过一些东西。没关系。这就是为什么你有像 git 这样的版本控制（即使你讨厌它）
- 职业发展的最好方法是换公司
原文链接：
原文链接： https://old.reddit.com/r/ExperiencedDevs/comments/nmodyl/drunk_post_things_ive_learned_as_a_sr_engineer/
国内中文：https://www.ruanyifeng.com/blog/2021/06/drunk-post-of-a-programmer.html
如何编写好的软件文档
推荐一些国外著名的网站：
文件系统：https://documentation.divio.com/
普通语言网站：https://www.plainlanguage.gov/