主要观点:开发者是天生的问题解决者,写作是开发者工具包中被低估的技能,包括文档、PR 和博客写作,良好的写作能节省时间、预防错误、提升职业发展,长期来看能带来诸多益处。
关键信息:
- Atlassian 报告显示开发者因文档和组织效率问题每周平均损失 6 小时,真正瓶颈是沟通。
- 开发者写作可分为文档、PR 和博客三类,各有不同目的。
- 好的文档写作应像读者在紧急情况时会阅读的那样,介绍一次缩写,链接到相关上下文,包含实际代码示例等。
- 好的 PR 应结构清晰,有行动驱动的标题、解释原因、指出重点区域等,能减少审查时间。
- 开发者应多写博客分享学习和经验,博客应简短具体、有价值。
- 写作实践应精确使用技术语言、展示而非讲述、便于快速扫描、提供上下文等。
- 可通过自我审核清单来检查各类技术内容的写作质量,包括文档、PR 和博客。
重要细节: - 以具体代码示例对比了好文档和坏文档的差异,如对函数的详细注释。
- 给出了 PR 的模板,包括标题、上下文、范围、测试说明等。
- 展示了博客的简单模板,如解决的问题、尝试的方法、解决方案等。
- 列举了提升不同类型写作的工具,如 Docusaurus、Swaggo、MarkdownLint 等。
- 强调写作要精确、有行动导向、保持人性化且专业等。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。