Uber在GO计划上的学习分享了整个办公室海报的编码技巧和有用的工作实践。这些技巧来自Uber工程社区的日常体验。我们将定期与Uber Eng博客上的大型工程社区分享它们。雷竞技到底好不好用
工程师构建的产品或服务的技术文档有助于新用户,传播有关服务方式的信息,并将技术术语转化为可理解的散文。一些技术公司,包括Uber,雇用了专门的技术作家与工程师合作并推动前进的文档工作。但是,当没有技术作家可用时,技术文档通常是由工程师撰写的,并且是开发工作流程的重要组成部分。
在编写技术文档时,保持简洁可能会具有挑战性。这里有一些可以帮助的技巧:
| 1.练习读者同理心。 了解您的听众。牢记他们写信以解决他们的痛点,并为他们提供准确的信息。 |
2.避免回旋处和道的表情。 “我们的网站已提供您可以使用的许多东西为了决定最好的存储解决方案。” “我们的网站提供资源用于确定最好的存储解决方案。” 通过减少措辞,您可以节省读者的时间,并为您的写作增加清晰度。 |
| 3.考虑阅读时间。 更长的时间并不总是意味着更好。请记住文档长度! 长文档顶部的TL; DR或概述部分还可以帮助读者更快地找到所需的信息。 |
有兴趣在鼓励工程师分享最佳实践的环境中工作吗?考虑在Uber申请角色呢
注释







