小小书 Writing Productivity Fiction Storytelling Learning Books Short Story Literatura Reading Literature Book Review Publishing Science Fiction Authors Flash Fiction Nostalgia Libraries Books And Authors Short Fiction Book Recommendations SciFi Thriller eBooks Serial Fiction Novel Kindle Readinglist Horror Fiction Fiction Writing Audiobooks Recommended Reading Book Club Reading Books Summer Reading

关于 文档 的优秀文章 – 第5页

哪些行业需要技术作家(第2部分)

上周,我们开始了新的博客文章系列,其中列出了需要技术作家的行业,并描述了那里的工作情况。 在这里查看第一部分。 今天,我们将继续列出有兴趣雇用Techcomm专业人士的行业。 让我们仔细看看保险,政府,工程和制造业。 保险 让我们从保险业开始。 保险公司雇用了很多技术作家。 实际上,他们有独立的作家和编辑部门。 通常,主修英语(或其他语言,取决于您所在的国家)的人在那里工作。 一些部门专门处理合规性问题。 如果您想在那里找到工作,则应获得一些“法规合规”认证。 了解规则非常重要,因为一个错误可能使公司损失数百万美元。 尤其是在我们谈论投资银行等高端行业时。 可能会有所帮助的另一件事是理解金融工具-存在许多涵盖该主题或金融写作作为特定技能的课程。 政府 政府还出于多种原因聘请技术写作专家。 在政府中,技术作家最受欢迎的工作之一是在不同的政府产品或服务上创建文档。 他们通常写检查报告,行政指导,政策程序文件。…

技术作家的风格指南

在我的文章“技术写作工作的弊端”中,我提到技术作家应遵循风格准则和标准,因为技术文档应简洁明了且语法正确。 但是新手可能会问,他们应该遵循哪些样式指南? 为了回答这个问题,我创建了一个列表,您将在下面找到它。 首先,让我们弄清楚什么是样式指南。 样式指南是一套用于编写和设计内容的标准; 它定义了在特定组织内进行沟通时应使用的样式。 例如,如果您具有新闻学背景,则可能已阅读《芝加哥风格手册》。 该样式指南提供了有关语法和语法的常规信息。 但这仅不足以编写技术文档。 为了以更清晰的方式编写文档并在文档中保持一致的语调,声音和样式,请阅读并遵循以下样式指南之一: 列表式样式指南 List Apart探索了Web内容的设计,开发和含义,特别关注Web标准和最佳实践。 Techprose技术写作指南 自1982年以来,TechProse就是一家业务领域的技术写作,培训和信息技术咨询公司。该手册提供了技术写作指南,并为创建逻辑性和专业性的书面材料设定了标准。 TechProse将其提供给与TechProse员工一起学习技术写作的工作人员作家,顾问和学生。 微软风格手册 最大限度地提高信息的影响力和准确性!…

什么是技术写作报告?

在本文中,我将告诉您什么是技术报告,公司为什么需要它以及如何编写它。 什么是技术报告? 技术报告是描述科学或技术研究的进度,过程或结果的文档。 它还可以包括一些建议和结论。 技术报告可以被视为灰色文献,因为它们在发表之前很少经过全面的独立同行评审。 技术报告是技术或科学信息的重要来源。 可以编写它们以更广泛或内部分发。 为了建立新颖性,当研究人员不想等学术期刊发表其作品时,技术报告可以被视为科学论文的主要形式。 因此,如您所见,技术报告是研究的关键部分,也应根据既定规则编写。 在下面,您将找到一些有关如何编写它的提示。 技术报告要素 典型的技术报告包含以下元素: 标题页 引言 摘要 实验细节 结果和讨论 身体…

技术文档的定位

技术写作是帮助人们了解事物如何运作的手段。 这些人是随机的吗? 一点都不。 对于每本用户手册,其读者至少都有一个共同点,那就是它们都使用相同的产品或服务。 如果我们退后一步并调整规模,我们会发现这些读者的共同点远不止于此。 因此,一旦您弄清楚了它是什么,它将定义您作为技术作家所做的一切。 针对技术文档的想法很简单-您需要说的语言与读者理解的语言相同。 “我为谁写作?” -是您需要回答的基本问题。 事实是,应在采取任何进一步措施之前予以回答。 如何确定目标受众? 您可以先询问公司中的人员。 即销售和营销团队。 请注意,出于我们的原因,他们的答案需要加一点盐,我们将进一步解释原因,但是,现在,让我们看看您可以向同事提出哪些问题。 基本上,您需要创建一个普通读者的肖像,因此,这里有几个要考虑的标准: 年龄 性别 占用…

撰写研究论文的第八步:引用来源-MLA还是APA风格?

萨曼莎·加德斯(Samantha Gades)在Unsplash上​​摄 当您被邀请参加聚会时,如何确定穿什么衣服? 您是否根据聚会的地点,参加者,甚至聚会的主题或场合来决定自己的服装? 您最有可能根据上述一个或多个因素做出决定,然后选择合适的款式和服装。 编写学期论文时,还必须考虑样式,并且选择的文档样式将主要基于论文的主题和老师的期望。 信不信由你,当您写学期论文时,您可以使用多种文档样式。 但是,最常见的两种是MLA样式和APA样式。 MLA样式 。 根据普渡大学在线写作实验室的说法,现代语言协会的风格“最常被用来撰写文科和人文领域的论文和引用文献”(“ MLA格式和风格指南”)。 因此,如果您正在学习写作课程,文学课程,语言课程或艺术课程,您的讲师可能会要求您使用MLA风格。 但是请注意,如果您正在学习写作课程,但是论文的主题不是艺术或人文学科,那么您的讲师可能会要求您使用其他风格。 还要注意,一些在艺术和人文科学领域之外授课的讲师也可能会要求您使用MLA风格。 照片由russn_fckr在Unsplash上 MLA样式具有两个必需组件和一个可选组件。 首先,您必须为来源添加括号引用。…

ClickHelp速览—导航,分类法,微型TOC,FTS

随着3月ClickHelp版本的临近,由于我们希望与您分享过去几个月来我们一直在努力的所有令人敬畏的事情,因此ClickHelp团队变得越来越兴奋。 这篇先睹为快的博客文章专门介绍了分类法,全文本搜索和导航的重大功能改进。 继续阅读以了解这些功能在此产品更新中将变得更好。 使用分类法 我们的客户已成功利用分类法功能在其在线文档门户上设置FTS。 分类法或索引关键字的思想是,您可以为主题指定它们,这将影响FTS结果。 这些关键字将被认为与所讨论的主题高度相关。 当读者有机会使用过时的术语寻找主题时,这里的常见用例是将过时的术语用作关键字。 主题本身可能缺少此类术语,但是索引关键字会将其推到搜索结果的顶部。 可以将索引关键字添加到帮助主题,如以下屏幕截图所示: 每个主题可以具有一组唯一的关键字。 以下是帮助主题的分类列表: 基本上,索引关键字既可以用作搜索参数,又可以帮助主题导航过滤器。 要浏览项目,读者需要在目录中打开索引关键字列表: 单击“ 显示索引”按钮将打开此项目的分类列表: 另外,您可以用逗号分隔关键字,索引将如下所示: 选择其中一个关键字将显示相关的帮助主题。…

每天可以节省1个小时的时间。

有时候,您从来没有想过您不知不觉地花了多少时间在早上没有做任何伟大的事情或没有取得成果。 该博客中的提示可能会帮助您将每天的​​时间增加1小时。 1. 提前安排您的服装:这肯定会为您提供帮助,因为有时业务专业人员最终每天会花费15–20分钟进行搜索,并思考哪种衣服组合在特定的工作日看起来最合适。 因此,您可以在吃饭时或上下班上下班时考虑一下。 2. 方便安排会议时间表 :很多时候,没有助手的商人往往会忘记当天的一些会议,最终错过会议安排的时间。 如果方便的话会更好,因此您不必再花时间在同一次会议上。 3. 整理您的文件:对于任何想好好管理自己时间的人来说,这都是非常重要的。 没有人喜欢在一堆无用的文件中找到一份重要文件。 为了成功进行时间管理,您必须学习组织事物的技能。 “上下班通勤是企业家最终浪费时间的另一种方式。 但是现在,他们可以使用一些最佳的GPS /地图应用轻松解决此问题,这些应用可以建议最短的路线,帮助计算ETA,显示路况,帮助用户计划聚会,为他们指示路线等等。” 2017年7月26日) 4.…

我最喜欢的段落

本周,我庆祝为Slack工作两年。 我一整天都在打字,打字是我在打字的过程。 那天晚上 尽管我为自己的断断续续的隐喻和冗长的词弄糊涂而感到内gui,但确实确实应该清楚地编写文档。 海中的岛屿就像我一样 信息是漂浮在海道中的岛屿。 大多数人是独立的,可见的或看不见的,但有些人会产生这样的火山对话,从令人鼓舞的信息中回荡,形成一种群岛的线索。 这是有关消息如何链接在一起以及您的应用程序如何读取,写入和与线程共享的故事。 自定义状态的潜力 了解如何将状态与日历,隔间,电话会议和浴室摊位同步。 是营业时间 一个Slack团队是一个Slack团队是一个Slack团队。 团队是一个工作空间。 工作的地方。 都非常认真 嘿,斜线突击队! 我确实 松弛的应用程序可以做一点。…

重点关注扩展内容

Mikito Tateisi 大约六个月前,我的团队面临着组织公司知识库的挑战。 那时,摆在我们面前的是五百篇文章,每篇都用三种不同的语言(英语,葡萄牙语和西班牙语)撰写。 我们的目标是对此类知识进行分类,以便以结构化方式对其进行维护和扩展。 我已经专注于所有内容几个月了,但是-从我从不同角度解决问题的过程中-仍然存在一些基本的疑问。 我很愿意单独改进文章或判断整体文档的质量。 但是很快就清楚了,如果没有整理一切,也就是没有回答那些根本性的疑问,那么最大的编辑努力和最佳的编辑判断都不会产生重大的变化。 这些疑问很简单,但是答案是构建我们需要的动态,详细信息的关键: 数据库中每篇文章的每篇译文的最新版本如何? 支持团队在多大程度上使用我们的文章来回答客户? 没有文章回应的客户问题占百分之多少? 我们的数据库目前涵盖的知识范围是什么? 我们需要提供的知识总范围是什么? 答案在哪里可以变成能够涵盖所提供知识和所需知识之间差距的文章? 1.版本控制 组织知识库的工作始于最明显的方式:一个电子表格,其中包含我们在Contentful中拥有的文章列表,这是我们已经使用一段时间的CMS。 随之而来的是最初的挑战:如何控制这些文章的翻译阶段?…

撰写研究论文的第三步-开始研究

由Eliott Reyna摄于Unsplash 撰写研究论文有点像准备一顿饭或一份特殊的甜点,特别是在收集过程中。 正如厨师必须事先收集所有食材和所有炊具一样,您也必须收集某些信息。 这是一个四步概述,概述了撰写出色的研究论文需要收集的内容。 1.首先,收集有关您主题的尽可能多的材料 :书籍,杂志,报纸,小册子,数据库信息以及来自知名来源的网站信息。 通常,来自教育网站(.edu)和政府网站(.gov)的网站信息比来自组织网站(.org)和商业网站(.com)的信息更加客观和可靠,因为后者试图吸引您的支持他们的事业或购买其产品或服务。 2.然后,预览资料,并有选择地阅读 。 一旦收集了尽可能多的信息,您显然应该开始阅读它,但不要立即尝试阅读每个文档的每个单词来使自己不知所措。 例如,如果您正在撰写有关萨拉托加战役的文章,而其中一本有关“独立战争”的书仅包含有关该特定战役的一章,请仅阅读该章。 如果您有时间稍后阅读整本书,则可以这样做,但前提是要吞噬与您的主题相关的所有内容。 David Clarke在Unsplash上​​拍摄的照片 3.接下来,保留您的来源的完整记录 。 实际上,您可能希望在撰写论文时开始将您的作品引用页面或参考页面放在一起。…

  • Previous
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • Next

Supreme Topics

1月17日聚焦作家的志趣

作家

三速发展— Tony Robbins和Tim Ferriss的超高生产率提示

教师应避免循环阅读的7个理由

您知道什么时候清晰可见。 (不,真的,您愿意。)工作,挤牛奶,使用它。

掌控您的个人生活

骄傲地跳舞

捷克语对英语的影响的例子

通过流动的力量找到实现

『料理の友』とは,そしてそのターゲット层は?

如何构建故事

我感觉很不好

变形I:DOGma

成为成功的自我出版作家意味着什么?

房子后面的房间

  • Copyright © 小小书 - All Rights Reserved.
  • Topics
  • Terms
  • Privacy Policy