About

技术写作技巧与工具的探讨

Author Tanmer Tanmer
Tanmer · 2025-05-29发布 · 14 次浏览

本文讨论了GitLab的高级技术作家Jonathan Glassman在技术写作领域应具备的技能,以及他对不同工具和写作范式的看法。内容涵盖了职业转变和与主题专家的沟通技巧。

https://document360.com/blog/hard-skills-vs-soft-skills-in-technical-writing/

GitLab 的高级技术作家 Jonathan Glassman 与我们一起参与这一集的知识库忍者播客,并讨论了技术作家在该领域应具备的技能。他还讨论了在技术写作中可能有用的不同范式和工具。

关于乔纳森

  1. 乔纳森的领英 

  2. 在英国保险业工作期间,他经历了职业转变过程,发现技术写作更符合他的目标和技能。

  3. 最初,他担任法律技术作家。在担任该职位期间,他能够编写一些软件文档。后来,他与政府数字服务部门合作编写他们的软件文档。

  4. 最近,他转到 Gitlab,担任高级技术作家。

要点

  • 乔纳森认为,任何职业的基本技能都是能够与人沟通,无论使用何种沟通方式。

  •  “然而,在技术写作中,我总是寻找能够在交谈时与主题专家建立关系的人,从他们那里获取信息,然后构建您需要构建的文档来满足您需要满足的这些需求,”他说。

  • 另一项技能是在基本层面上关注细节。它不仅关注 Starguide,还确保您正确遵循有助于远程设置工作的工作流程。

  • 人们很容易总是把注意力集中在硬技能上,甚至是某人简历上的文字上。但如果一个人不愿意学习新技能或工具,他们就很难为团队或任何组织做出贡献或增加价值。

  • 乔纳森认为,现在能够使用命令行是一项非常好的可转移技能。这将使您在技术写作领域处于有利地位。

  • 文档即代码是一种直观的工具,在提供帮助和支持方面反应非常灵敏。这是文档中需要关注的所需技能之一。

与乔纳森的快速射击

  • 影响最大

“在我的职业生涯中,我很幸运能够与一些才华横溢的人一起工作,他们激励我成为一名更好的技术作家。从 GDS 和 GitLab 的技术作家那里学到了很多东西——Laura Hiles、Jen Lamborn 和 Rosalie 等等,我从他们身上学到了很多东西。 “

  • 强烈推荐资源

“编写文档”社区非常棒,我宁愿由汤姆·约翰逊 (Tom Johnson) 撰写。

  • 这是你会给 20 岁的自己的一条建议。

 “写下你在工作中取得的所有成就,因为这样在回顾时间时会更容易。这听起来可能有点传统,但不幸的是,在我们生活的世界中,详细的文档将对您的生活有很大帮助。”

订阅知识库忍者的评论:

  1. 苹果

  2. Spotify

  3.  RSS

提交反馈

资讯 资讯

直达客 AI 知识库平台,助您快速构建企业AI知识库,提升团队效率,释放知识价值。

直达客 AI 知识库平台介绍

直达客 AI 知识库平台介绍

AI 赋能,知识直达!直达客 AI 知识库平台,助您快速构建企业AI知识库,提升团队效率,释放知识价值。

Author 926b
By 数字体验专家
发布:2025-05-26
赢得客户终身信任的客户支持策略

赢得客户终身信任的客户支持策略

本文探讨了在制定客户支持策略时需要关注的重要统计数据,强调良好客户支持对客户忠诚度的影响,并提供了提升客户体验的建议。

Author customer-support-strategy-data
By Tanmer
发布:2025-05-26