技术写作小小书 XXshu

谁是技术作家？

为了定义术语“技术作家”，我们参考字典。因此根据牛津在线词典，“技术”一词手段： 1.与特定主题，艺术或手工艺或其技术有关 2.涉及或涉及应用科学和工业科学 3.由于机械故障 4.严格遵守或解释法律或法规从这些解释的角度来看，我们可以得出结论，技术作者处理技术文献。因此，技术作家是将复杂的想法转变为简洁明了的文档的人。技术作家可能在工程，医学和科学等不同领域工作。职责范围技术作家应具有沟通能力，良好的语言表达能力，完善的研究和探索能力。这项工作是关于使用易于理解的信息创建文档的。建议读者可以找到，理解和使用文档。技术作家在写作过程中应始终牢记听众的知识水平。例如，医师使用的医学信息可能以复杂的方式呈现，因为它假定读者具有必要的知识。技术写作还有另一个同样重要的方面。这是文档设计。…

物联网和技术文档

物联网市场目前正在迅速发展，每天有数百万个设备在线。在未来的几年中，我们将谈论数十亿个这样的设备。而且，由于没有充分的理由让物联网以这种疯狂的速度停止发展，因此最终我们将获得数千亿美元。这在所有电子设备中占有很大份额。并且，当然，技术文档应该在用户那里。技术作家最感兴趣的问题是：技术写作将如何变化？是否必须适应新环境？这是我们认为在过渡时期将要发生的事情。技术作家将更接近开发过程。使文档团队参与开发过程将使他们对工具的工作原理有更深入的了解。如果您知道其工作原理，则可以向其他人解释。尽管似乎当前的现实将这一情况推向了新的高度，但技术作家经常需要与就业领域相关的附加资格这一事实已是老新闻。由于物联网与可用性有关，因此冗长而复杂的用户指南将不再起作用。因此，帮助信息需要及时并少量地提供给用户。这就解释了UX作家的职业机会的增加。这种职业仍在弄清楚它想要成为什么样的人。雇主仍然不确定公司中的UX编写者是否需要扮演单独的角色，或者已经在职的人员可以承担这些责任。…

技术作家的最佳课程/书籍/资源

by ClickHelp —专业的帮助创作工具创建此职位是为了帮助技术作家找到有助于职业发展的有用资源。在这里，您将找到经验丰富的技术作家和刚刚开始其职业旅程的人的资源。乌迪米目前，这个庞大的学习门户网站为愿意提高技能的技术作家提供了15种可能的选择。一些课程涵盖特定主题，例如：API技术写作，制造业和航空航天业的技术写作。但是，也有几门课程有望提高您的技术写作技能。从客户的反应来看，以下在线课程非常适合初学者-专业技术写作：提高您的写作技巧（请注意，Ugur Akinci将是您的课程教授，他本人也是非常有经验的技术作家）。对于更高级的技术作家，他们应该查看本课程-技术写作：掌握写作生涯。它的创造者承诺将帮助您变得更加盈利和成功。 Study.com 该网站提供了坚实而透彻的技术写作课程，称为“英语305：高级技术写作”。该课程本身包括视频及其成绩单以及每个章节的简短后续测验。所有带有说明的章节都可以在课程页面上找到，该页面非常方便-您可以了解其中的内容并立即决定是否要注册。威斯康星大学欧克莱尔分校威斯康星大学为技术作家提供了令人印象深刻的在线课程清单。…

创建技术文档时应避免的7件事

技术写作不同于其他形式的写作。其目的通常是提供有关该主题的指导，以帮助用户解决问题。由于技术写作具有如此独特且明确的目标，因此好的技术写作必须遵循特定的准则。让我们看一下编写技术文档时应避免的一些最重要的事情。 1）语言模糊 “短时间”是多长时间？“大量”是多少？“空”，“显着”，“以后”，“沉重”和“许多”等模糊的描述符是开放的要解释，因此模棱两可。此外，这些术语在时间上是相对的：35年前被认为是“短时间”的东西很可能会在将来被判定为“长时间”。技术的进步会使使用这种语言的技术文档过时，因此请始终尝试尽可能具体。 2）被动语态主动语音比被动语音更强更直接。例如，最好说“ 使用您的帐户信息登录”，而不是“使用您的帐户信息登录”。活动的声音通常更清晰，更简洁。就是说，有时候技术写作者会使用被动语态：例如，当主题未知或不如宾语重要时，或者主动语态暗示读者应为可能超出其阅读范围的情况负责控制。考虑“如果无法启动系统…”和“如果无法启动系统…”之间的区别。 3）不必要的信息使您的文章简短明了。如果它不能帮助用户解决问题，则需要解决。请勿包含有关技术或营销语言的内部运作的琐碎细节，这些技术或营销语言称赞它是工程学的胜利。…

作为技术作家管理写作样本的5个技巧

图片来自DươngTrầnQuốc通过Unsplash.com 过去几年中，随着每份新的技术写作合同，我似乎都在我的NDA文件夹中添加了一份新的保密协议。虽然不是每个技术作家都可以处理公共领域的文章和文档，但是您可以做一些事情来确保您有工作样本来展示潜在的雇主，包括： 1.做义工将志愿工作作为潜在的工作样本来源，可以向潜在的雇主和客户展示。机会可能就在您眼前，或者您可能必须将志愿服务的目标锁定在需要技能的地方，然后才能增加工作量。例如，我曾经在我的老教堂的社交媒体研讨会上教求职。我将PowerPoint幻灯片平台上传到SlideShare，因此可以作为我的工作样本。 2.通过保密协议寻求妥协如果您的雇主或客户半途而废，请与他们进行对话，以将您为他们执行的工作用作工作样本。甚至可能达成协议，同意使用文档的选定部分或删除整个文档的某些部分以屏蔽不需要进入竞争对手手中的任何专有内容。以后寻求解决方案作为样本在组织中可能是一个棘手的主题，因此，即使与您信任的经理和客户一起，也应始终谨慎对待。 3.永远不要让工作样本离开您的视线在开始为公共领域的出版物和网站写作之前，我从未被教导要让我的写作样本在面试时离开我的视线，并且仍然相信这一规则。 4.像专业人士一样对待您的个人项目中型，LinkedIn发布平台和WordPress在发布和使自己上网方面都是很好的均衡器。克服工作样本困境的一种方法是，将在线放置的任何作品视为绝对最佳，最专业的作品，即使它是个人网站。 5.等待工作老化…

如何成为技术作家并进一步发展

2010年，《美国新闻与世界报道》将技术写作评为全球“最佳职业50强”之一。对技术作家的需求仍在增长，而这种写作利基市场是当今最赚钱的领域之一。下一篇文章将快速介绍技术写作的概念，描述必要的教育和培训，以深入了解利基市场，以及一些进一步发展为技术传播专业人员的机会。什么是技术写作？技术写作是一个写作利基市场，专门研究事物的工作原理，并帮助他人执行特定任务并实现选定的目标。技术作者会创建程序或“如何”文档，这些文档是逐步指南，知识库，故障排除文档以及其他类型的技术文档。如果您有兴趣成为一名技术作家，则以下提示可帮助您入门。下面，我们将介绍建立专业声誉的各种方法，并列举出提高竞争力所需的技能。必要的教育和培训为了汇编以下建议，我们搜索了技术写作领域的数千份工作。我们得出结论，应聘技术作家应接受以下教育和培训。在职位描述中要求最高的是新闻学，传播学或相关领域的学士学位。这些程序教授基本的书面交流技巧。如果您想领先于竞争对手，则必须具备高级学位。许多大学提供技术写作和交流认证课程。其中一些由英语部门管理，另一些由工程计划管理。…

技术文档中的普通语言基础

技术写作或技术交流是关于向普通受众传递技术信息。在技术文档中使用通俗易懂的语言可以使文章清晰，简洁并且对读者有所帮助。通俗易懂的语言写作可以帮助目标受众轻松理解信息，避免误解并节省时间，因为它可以使工作第一次完成。定义简单的语言悉尼大学前现代英语语言副教授罗伯特·伊格森（Robert Eagleson）教授将通俗语言描述如下：朴素的语言是清晰，直接的表达方式，仅使用必要的单词；这种语言避免了晦涩难懂，夸张的词汇和复杂的句子结构；这不是在谈论婴儿，也不是英语的简化版。普通英语的作家让他们的听众专注于信息，而不是被复杂的语言所分散；他们确保听众容易理解消息。通俗易懂的语言是在使目标受众首次阅读时可以理解并采取行动。法律写作是技术写作的一种。它的显着特征包括语法过于复杂和过于形式化的趋势。比较以下示例，以了解使用简单语言编写的思想。前两段包含对读者来说不必要的多余信息，只有最后一段暗示了消息的目的。此外，整封信以过分正式的方式写着，句子冗长，不常见的单词和陈词滥调，难以阅读。让我们看看简单的语言是否可以改善本文。…

一位新技术作家的话

2017年5月，我成功捍卫了自己的论文，几个星期后，两年的不眠之夜和无休止的数位论文数字化在一定程度上达到了顶点。就这样，我完成了！除非我真的没有做完，否则我不得不开始寻找我的第一个技术写作工作的艰巨过程。从亚利桑那州立大学获得硕士学位7个月后，命运和毅力使我参加了在奥斯丁市中心举行的“编写文档”会议，在那里我遇到了高级技术作家，该职位最终将我聘用为我的第一任正式职位。对于那些不熟悉的人（我毕业后才了解WTD），他们是一个组织，除其他事项外，在许多城市举办每月免费的聚会，他们讨论实用的Comm Comm主题，例如专业人员使用的工具和相关的最佳实践。。 2018年1月2日，我开始了我职业生涯中最激动人心和最恐怖的章节之一，在酒店业担任了十年董事之后，我正将自己的热情带入开阔的水域。在开始这个冒险的两个月后，我终于有足够的基础来谈论我的经验，包括新技术作家。我不会将它们称为课程，因为我不敢尝试向任何人传授有关我仍然习惯的领域的任何知识，但是我仍然想分享对这种新经验的看法。有很多东西要学习。但是，还有很多东西要学习！这里没有什么大的惊喜-技术一直在发展。这意味着，当您完成学位，证书课程，新手训练营等工作时，可能已经有更改，有可能使您学到的工具过时。好消息是，每个人都在同一个船上，为跟上快节奏的行业而努力。在求职过程中遇到的每个人，自从开始担任技术写作职务以来，所有人都知道需要学习的“东西”的数量，而且大多数人都承认，任何人都不可能一无所知。对于新来的人来说，甚至不知道从哪里开始尝试追赶也可能是艰巨的。比起我在Tech…

成为技术作家的5大理由

您想到技术写作时会想到什么？许多人认为这项工作困难而无聊，因为这涉及编写各种类型的说明，复杂的报告或产品说明。这就是为什么许多人不愿开始自己的技术交流事业的原因。但是技术写作远不止于此。为了消除您的疑问，我们采访了技术作家，并询问他们为什么决定从事技术写作事业。使用他们的回答，我们写下了成为技术作家的5大理由。这是一个创造性的工作许多人认为技术写作是一项枯燥的工作。这在一定程度上是正确的，因为技术文档编写听起来并不有趣。但是技术写作不仅涉及文本，还涉及视觉交流。后者意味着技术作者必须处理不同的图形工具，不仅要创建图像，图表或图表，还要创建音频和视频文件。此外，这项工作不是例行工作-今天邀请您介绍一个项目，明天邀请您创建视频，等等。工作的写作部分也有很多优点。例如，开发产品的用户指南提供了在发布最新技术和设备之前使用它们的机会。 “技术写作可以帮助人们更好地理解技术，从而提高人们适应影响我们生活各个方面的新技术浪潮的能力。这有助于我们增加生活的充实感，并增强应对日常挑战的能力。这就是技术写作的技术授权方面。”…

如何成功踏入大门：科技写作的全职妈妈告诉所有人

好的，我在第一个实质性的中级职位上有很多需要解决的问题，但是我保证每个人都可以拿走一些东西……一个文学形式的好东西！背景和婴儿首先介绍一下我和我的处境。我是一名来自加利福尼亚州奥克兰市的新手级技术作家，他于去年五月下旬从一个了不起的技术和专业写作学士学位课程毕业。不到一个月后的六月，我生下了儿子朱利安（Julian）。信不信由你，时间是故意的-我喜欢效率！尽管强度不是100％的深思熟虑（什么样的初生父母可以真正预测照顾24/7小人类的改变人生的经历？）我正在积极追求专业写作生活，我很激动。试图照顾婴儿并在繁华的技术写作领域中找到自己的脚步可能是一项繁琐的任务，但我固执地喜欢挑战。妈妈的小帮手当我在我3.5个月大的呀咕咕叫声和我的陪伴下打字时，我意识到以在家待业的妈妈身份来换专业球有很多弊端，但您可以自己解决这些问题。由于我今天心情愉快，所以我想指出我所处的主要优势。存在远程签约工作，这对我来说也是吃蛋糕的好方法。我带着我亲爱的甜蜜回家，并以适合自己的步伐发展自己的职业生涯。我计划在后续职位中谈论作为在家工作的妈妈的时间管理策略，所以请继续关注专业的父母和家庭！实现它需要什么所以我站在这里。一个真正的现场付费作家。…