B y T e c h n i c a l C o m m u n i c a t i o n L t d

T h e P r o f e s s i o n a l T e c h n i c a l W r i t i n g P r o v i d e r

w w w . t e c h n i c a l c o m . c o . i l

技术文档菜单

Importance

当你进入一间餐厅， 您被带领到保留位子上。服务员 将菜单

放在你面前，让你从中选择你喜欢的菜肴。

我们提出这个技术文档菜单是相同的道理，让您可以从中选择

最适合您的需要项目。

对於这个菜单，我们目前的想法是：

只要您的客户能更了解所购买的产品或服务细节，

他们就更可能發現新需求，購买额外的产品，从而增加销售。

Menu Lists

以下列出了菜单的文件类型：

最后一节的主题为「马上启用」，是讨论何时开始制作文件菜单。

当你考虑下面列出的各种文档选项，试想您的企业如果不保持文字记录和专有技术，很有

可能会影响您与客户的关系。

产品结构树

目的和用途

产品树 展示了产品的架构。它包含了BOM表（ 物料清单）以及识别每个零件的信息，以

及产品的层次结构。.

呈现方式

BOM表与与库存记录连结，含有生产指令和时间表。

结论

没有产品树，制造指令必须在每次制造时重新产生，零件控制和 材料控制 无效率 。你不能移动各项产品之间的资源，零件或材料 ，也无法利用准确的记录，以最有效率的方式降

低库存，无法大幅提高物流效率。

用户指南

目的和用途

用户指南，也被称为“操作手册”; 这是为了有进阶知识的和计算机操作员而写 。本手册可用在工作现场。

呈现方式

印刷版的用户指南或电子书籍，如PDF文件，或两者兼而有之，可供现场人員使用。

结论

没有用户指南，使用者将在设备或系统的使用中感到沮丧和 。客服中心也将有超过工作

负荷，贵公司的专业型像也可能处于危机中。

安装和维护手册

目的和用途

这些专用手册，可帮助并培训用户在工作现场

自行安装丶配置和维护设备系统。

这种类型的手册还包含故障诊断措施，和登录过程

中对安装技术人员进行远程监控。

呈现方式

印刷版的用户指南或电子书版本，如PDF文件，或两者兼而有，方便用在工作现场。

结论

如果没有可上手的手册，用户 将感到沮丧，无法安装设备或系统。客户服务中心将有过多

的工作负荷及客户来电。客户对於贵公司的信心可能动摇。

技术手册

目的和用途

这些专用手册，可帮助技术人员在工作现场安装丶配置和

维护设备或系统。

呈现方式

印刷版的用户指南或电子书版本，如PDF文件，或两者兼有之，

方便用在工作现场。

结论

如果没有可上手的手册，技术人员将无法安装与维护设备或系统。研发团队也可能因此被

频繁的叫动。造成长时间的停机，这将阻挠买方和采购组织的购买意愿。

快速指南

目的和用途

快速指南，一般浓缩为两页长，并 有个非常特别的目的。旨在提供应用程序或设备上，开

始工作所需的最基本信息。

呈现方式

一本可以由用户或技术人员携带的小册子，其中的各项信息可以一目了然。

结论

如果没有快速指南，用户將没有可随身携带的简短资料，需花更多时间搜索他处取得需要

的信息。

客服中心将涌入超重的工作负荷。 客户对贵公司的信心可能会受到损害。

在线帮助(OLH)

目的和用途

在线帮助的主要目地是，用户只要出现困难，能够马上查询解答，解决核心问题。最重要

的是，立即得到解决，同时保持程式和开启及运行。在线帮助是目前的趋势，更胜於一个

文本帮助手册。

呈现方式

透過可阅读文意的网路技术系统，提供加强的登录能力。

结论

提供线上帮助的竞争对手将拥有营销优势，他们的程式能更广泛地使用并创造更多的销售。

没有在线帮助，用户将退出应用程式并从其他来源寻求帮助 ，如用户指南 。客服中心将有超重的工作负荷及来电。贵公司的专业形像可能会受到损害。

软件文档纪录

目的和用途

没有文档纪录的软件，就不算完整。

呈现方式

软件文档注释和解释性说明。

结论

一个的软件即使不完整，但如果具有良好的文档，都可以更新改进。一个好的软件但如果配上质量很差的文档，将无法使用。

产品培训套件

目的和用途

用於工作场所，传授相关的技能知识。

呈现方式

一般來說，每個产品培训套件包含：

演示介绍

给予学员的详细信息文本，包含演示过程中的文本细节。

为培训导师所做的教学指引列表。

结论

如果客户或员工没有适当的训练，其生产力将落后于其他训练有素的同事。

马上启用

对於何时应开始的文档制作上， 仍存在着分歧的意见 。有些人偏好 产品开发过程结束，

产品已准备完成后立刻开始。然而，在这么晚的阶段，能留给文档制作和核实的时间很

少，文件的质量可能受到影响。

比较好的方法，是当产品接近完成时，就开始开始文档制作。如此不但可 保证文件质量，

更可以如期限完成。

免费咨询

成功的的文档建立需要良好的管理和实际演练 。您可以加入我们的免费咨询计划，以确定文件类型，或回答您的疑问 。请通过我们的咨询，并设立一个拟真的文档建立计划。

欢迎造访我们的网址 www.technicalcom.co.il