这本在线技术写作书现在使用 技术文件 (技术文档 用于简短引用任何包含技术信息的文档—而不是使用 报告. 报告是本书中讨论的其他技术文件的一种子类别。
注意: 这本技术写作教科书专注于 技术写作技能. 这里的技术内容不保证准确或最新。
背景/信息报告
这种类型是最难定义的,但也是大多数人撰写的类型。它专注于一个技术主题,为具有特定需求的特定读者提供该主题的背景。此报告不提供指示,也没有以系统的方式提供建议,也没有报告新颖和原创的数据。
要完整了解这种类型的技术文档,请参见 背景/信息报告
商业计划
商业计划是用于启动新业务或为正在发生重大变化的业务获取资金的文件。商业计划对需要达成共识的商业伙伴、需要批准该计划的政府官员,当然还有可能资助该业务的投资者(如银行或个人)来说都是重要的文件。
看看 完整章节 关于这种技术文档。
技术导向用户指南
简要定义,计算机用户指南提供关于计算机硬件或软件的技术信息,包括设置、配置和基本任务等操作的说明。
看见 完整章节 在这种类型的技术文档中。
数据报告
数据报告是一个技术文档,其中包含大量以表格形式呈现的数据。它还可能包含图表和图形,以更生动地展示这些表格中的数据,并且有解释性的交叉引用,说明表格数据中的关键趋势和结论。
见到 完整章节 在这种类型的技术文档中。
工程设计报告
一个工程设计报告介绍并记录一个工程设计项目,以便他人理解该设计如何应用和商业化。例如,工程学生们曾撰写关于使用微控制器的温度测量和显示系统的设计。
查看 完整章节 关于这种类型的技术文档。
指南和指导文件
简单定义,a 指南 是提供逐步指示、提示和相关概念的出版物。它还可以包含故障排除信息、相关社区的链接以及相关研究的链接。
A 指导文件 是旨在向公众提供有用信息的政府文件,例如阐明现有法律或法规下的义务。它试图将行政规则中复杂的法律语言转化为易于理解的内容,以帮助公众遵守这些规则。
看见了 完成章节 在这些类型的技术文档上。
手册
简言之,手册是一种??? 来源,包含概念信息(基本理论、原则、基础知识)、教学信息(逐步指导)、以及参考信息(快速查找信息)。
查看 完整章节 在这种类型的技术文档中。
说明
简而言之,说明书告诉你如何建造、操作和修理事物—经典的“如何做”。对于技术写作学生,更倾向于 "以技术为导向的用户指南。"
看见了 完整章节 在这种类型的技术文档中。
文献综述
简而言之,文献综述总结了关于特定研究主题的已知信息,叙述了研究历史的里程碑,指出当前知识的冲突之处,并讨论了仍然未知的领域。
See the 完整章节 在这种类型的技术文档中。
主要研究报告(实验报告)
简而言之,初级研究报告呈现了实验室或现场研究的结果和解释。你可以把它看作是实验报告,但它远不止于此。
看见了 完整章节 在这种类型的技术文档中。
进展报告
简而言之,进度报告向监督者、合作伙伴或客户通报项目在某一时间段内的进展。项目可以是某物的设计、建设或修复,是某个问题或问题的研究,或是对技术主题的信息收集。
看到那个 完整章节 在这种类型的技术文档中。
提议
简而言之,提案是向某人提交的做某个项目的报价或投标。提案之所以称为提案,是因为它请求观众批准、资助或授权执行所提议的项目。
看见了 完成章节 在这种类型的技术文档上。
推荐,可行性,评估报告
这组类似的报告做一些事情,比如将几个选项与一组要求进行比较并推荐一个;考虑一个想法(计划、项目)在其"可行性,"方面,例如,它的技术、经济、社会实用性或可能性的某种组合;通过将其与一组要求(标准)进行比较来判断某物的价值或价值。
看见 完整章节 关于这些类型的技术文档。
标准操作政策和程序
这些是组织的操作文件;它们包含关于组织及其成员预期行为的规则和规定。政策和程序像说明书,但更为详细。标准操作程序(SOPs)更侧重于执行过程的程序—例如,进行牙科印模。
看见了 完整章节 在这些类型的技术文档上。
技术书籍出版
即将到来...
查看 完整章节 在这种类型的技术文档中。
技术导向用户指南
简要定义,计算机用户指南提供有关计算机硬件或软件的技术信息,包括设置、配置和基本任务等操作的说明。
见到这个 完成章节 在这种类型的技术文档上。
白皮书
简单来说,白皮书是关于项目(设备、方法等)的技术或商业文件,提供背景信息并为其辩护。白皮书已成为公司在互联网上的热门营销工具,因为许多潜在客户会在网络上搜索信息。公司使用白皮书来销售信息或新产品,作为满足客户需求的解决方案。
查看 完整章节 在这种类型的技术文档上。
相关信息
文档类型及其使用方法. WTD
