【Topic-based writing】Training slides on technical writing

如大家预料的,裁员在2025元旦假期之后的几天悄然到来,并在一天内速战速决。研发基于绩效CIP进行了5%的裁员。文档部门(在2024年划出研发划入Operation BU)意料之外减员惨重--50%的同事受波及被裁员。分析原因,内外因素兼而有之:公司私用化第二年,CEO为保靓丽财务报表,大刀阔斧开源节流,制定围绕大客户的服务宗旨把每年4次的release数减至3个(其中一个还是LTSR);AI 工具(Google Gemini企业版 + 集成式Copilot)从去年年中开始在全公司普及与推广。

从ChatGPT推出使用至今,由衷感谢它让我平衡了工作与生活,提升了生活幸福与成就感。用AI辅助生成与编辑文档,节省了工作时间,提高了工作质量,而且有了AI Tutor,个人英文写作与技术学习效率也大大提高。我认为,语言不再是中国人写出纯正英文文档的障碍。但,如我在之前文章中所提到的,AI的出现,对于初级writer,以及技术背景与领域知识学习能力不强的writer,可能意味着失业风险。AI对人才的要求越来越体现在综合能力上。

公司大幅裁减TW后,应对的决策是:将来由产品经理与研发提供用户文档Draft,Writers负责组织,编辑与发布文档。Writer核心职责将集中在:

- 目标受众文档需求分析

- 基于目标受众的文档组织与构架(Structuring)

- 文档编辑与审核(技术的无误与简洁表达)

作为留下来的writer, 我也在思考如何适应新的工作模式。为了减少后期编辑工作的effort,我打算先对研发人员进行一个基础的写作培训,然后为他们提供一套用于编辑文档初稿的Prompts。

以下是我的培训草稿,也作为我这么多年写作的一个总结吧,着重在:如何写技术文档,以及如何简洁撰写技术文档。参考文献:https://learn.microsoft.com/en-us/style-guide/welcome/



Slide 3


Slide 4


Slide 5
Slide 6


Slide 7


Slide 8


Slide 9


Slide 10


Slide 11


Slide 12
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容