这本在线技术写作书现在使用 技术文档 (技术文档 简称)指任何包含技术信息的文档—而不是使用 报告该报告是本书讨论的其他技术文档的一个子类别。

注意: 这本技术写作教科书专注于 技术写作技能. 这里的技术内容不保证准确或最新。

背景/信息报告

这一类型是最难定义的,但也是大多数人书写的类型。它专注于一个技术主题,为具有特定需求的特定读者提供该主题的背景信息。此报告不提供说明,也不以任何系统化的方式提供建议,也不报告新的和原创的数据。

有关这种类型的技术文档的完整章节,请参见 背景/信息报告

商业计划

商业计划是用于创建新企业或获得因某种重要变化而需要资金的企业的文件。商业计划对需要对其计划达成一致的商业伙伴、需要批准该计划的政府官员,以及当然可能资助该企业的潜在投资者(如银行或个人)来说都是重要的文件。

看到 完整的章节 在这种技术文档上。

面向技术的用户手册

简而言之,计算机用户指南提供有关如何使用计算机硬件或软件的技术信息,包括设置、配置和基本任务等操作的说明。

看到那个 完整章节 关于这种类型的技术文档。

数据报告

数据报告是一份技术文档,包含大量以表格形式呈现的数据。它还可能包含图表和图形,以更生动地展示这些表格中的数据,以及说明性交叉引用,指出表格数据中的关键趋势和结论。

看见了 完成章节 关于这种类型的技术文档。

工程设计报告

工程设计报告介绍并记录了一个工程设计项目,以便其他人理解该设计如何应用和商业化。例如,工程学生已经撰写了关于使用微控制器设计温度测量和显示系统的内容。

看到 完整章节 关于这种类型的技术文档。

指南和指导文件

简要定义, 一个 指南 是一份提供逐步指导、技巧和相关概念的出版物。它还可以包含故障排除信息、相关社区的链接和相关研究的链接。

一个 指导文件 是旨在向公众提供有用信息的政府文件,例如阐明现行法律或法规下的义务。它试图将行政规则的复杂法律语言转换为便于公众遵守这些规则的形式。

看见 完整章节 关于这些类型的技术文档。

手册

简要定义,手册是一个??? 来源,包含概念信息(基本理论、原则、基础知识)、指导信息(逐步指示)和参考信息(快速查询信息)。

看见了 完成章节 关于这种类型的技术文档。

指示

简而言之,说明书告诉你如何构建、操作和修理事物—经典的“如何做”。对于技术写作的学生,优先考虑 "以科技为导向的用户指南。"

看见了 完成章节 在这种类型的技术文档中。

文献综述

简而言之,文献综述总结了关于特定研究主题的已知信息,叙述了研究历史的里程碑,指出当前知识的冲突,以及讨论仍然未知的领域。

看到这个 完整章节 在这种类型的技术文档上。

初级研究报告(实验报告)

简要定义,初级研究报告呈现实验室或实地研究的发现和解释。你可以把它看作是实验报告,但它远不止于此。

看到 完整章节 关于这种类型的技术文档。

进展报告

简要定义,进度报告向主管、同事或客户通报在一定时间内项目进展情况。项目可以是对某物的设计、施工或修复,问题或问题的研究,或对技术主题的信息收集。

查看 完整章节 关于这种类型的技术文档。

提案

简而言之,提案是向某人提供做某个项目的报价或投标。使提案成为提案的原因在于它要求听众批准、资助或授权进行所提议的项目。

看到这个 完整章节 关于这种类型的技术文档。

建议书,可行性报告,评估报告

这一组类似的报告进行的工作包括比较几种选择与一组要求,并推荐其中一种;从其可行性角度考虑一个想法(计划、项目),例如,它的技术、经济、社会实用性或可能性的某种组合;通过将其与一组要求(标准)进行比较,对事物的价值或重要性作出判断。

查看 完成章节 关于这些类型的技术文档。

标准操作政策和程序

这些是组织的操作文件;它们包含了有关组织及其成员预期表现的规则和条例。政策和程序就像指示,但它们更深入。标准操作程序(SOP)更侧重于特定过程中执行的程序,例如,获取牙齿印模。

看见 完成章节 关于这些类型的技术文档。

技术书籍出版

即将推出...

看到的 完整章节 关于这种类型的技术文档。

面向技术的用户指南

简单来说,计算机用户指南提供有关计算机硬件或软件的技术信息,包括设置、配置和基本任务等操作的说明。

查看 完成章节 关于这种类型的技术文档。

白皮书

简而言之,白皮书是一个技术或商业文件,提供项目(设备、方法等)的背景并对此进行宣传。白皮书已成为企业特别是在互联网上流行的营销工具,因为许多潜在客户在网上搜索信息。企业利用白皮书来销售信息或新产品,作为满足客户需求的解决方案。

看到的 完成章节 关于这种类型的技术文档。

相关信息

文档类型及其使用方法. WTD