新加坡的专业工程师兼技术撰稿人Atul Mathur用这种方式描述了技术写作,“技术写作涉及两个关键能力。 首先是理解技术语言的能力; 第二点是能够以清晰,简洁和连贯的方式表达这些知识。 但是如何提高必要的技能并成为成功的专业人士呢? 本文将为您提供帮助!
许多学院,大学和其他教育机构都提供课程。 此外,还有许多在线课程。 例如,您可能会发现Coursera有用。 并且有免费的在线技术写作课程和培训计划列表。
除了课程外,单独检查阅读材料也很有用。 如今,有很多关于技术写作的书籍和文章,它们不仅可以帮助您提高技能,还可以提供有关如何建立事业,在该领域取得成功的建议以及其他有用的信息。 而且,如果您尚未担任技术作家,请实际应用您的知识。 您可以创建一个博客并查看新产品。 在社交媒体上分享您的作品,向潜在客户展示您的价值。 这种社交媒体经验在许多公司中都受到欢迎。


谈到您必须与数字发布软件(例如Adobe FrameMaker,Adobe RoboHelp,Microsoft Office)相关的经验; 一些行业需要Java,DITA,数据库语言等知识。
与数字工具相提并论,最好学习第二语言。 它使您可以检查本地化文档的质量,甚至可以翻译技术文档。
在阅读博客时,我遇到了博客作者与技术作家之间的对话:
“你写什么?”
“主要是实验和现场试验的记录。”
“你喜欢写作吗?”
“不,我绝对讨厌它。”
‘为什么?’
“因为它只是要放在一个尘土飞扬的文件夹里某个地方,而且没人会读过。” (资源)
如您所见,一些技术作家倾向于认为没有人会阅读手册或README文档。 但这不是真的。 如果没有人需要这样的文件,那么这个职业就不会存在。 因此,您必须发展自己的写作技巧并提高语法知识。 例如, Mary K. McCaskill (Langley研究中心)撰写的名为“ 语法,标点和大写:技术作家和编辑手册”的书包含许多有用的信息,可帮助您实现有效的技术写作的复杂性。 想了解更多? 这里有40本技术写作书籍!
在检查了这些书籍之后,您可以担任志愿者并编辑他人的技术写作作品。 这样的经验将使您对细节更加了解,并且您将获得自己的写作风格。


为了不重复您的错误,请记下错误和一个好的变体。 但是向我保证,不要害怕批评,随着实践和时间的发展,您会有所进步。
您如何提高技术写作技能?