热线电话:400-023-5779  QQ在线:285602136
当前位置: 首页 > 服务与支持 > 技术文档知识库
  • 32G DDR4 REG ECC,SSD SATA 120G,Xeon E5-2650 V3,双路十核机架式服务器 查看详情
  • 8G DDR3 ECC,HD SATA3 1TB,Xeon E3-1270 V3,单路四核图形工作站 查看详情
  • 8G DDR4 REG ECC,SSD SATA 480G,Xeon E5-2630 V3,双路八核工作站 查看详情

技术文档知识库

1研发文档编辑

指研发过程中使用的文档。英文一般称为Specification。
文档中详细记录产品的研发目的,开发阶段,研发时限等。阅读对象一般为了解项目,有一定基础的工程师。文档作为项目执行的参考,为项目的如期完成,项目质量跟踪,以及项目的后续发展等问题提供了可依据的文字上的依据。

2客户文档编辑

指产品发布以后,公布给用户使用的文档。英文一般称为Customer Documentation。
文档详细解释产品的具体使用方法,安全提示,客户服务信息等。阅读对象一般为用户,技术支持工程师,售后服务人员。文档作为产品和市场接轨的桥梁,为产品的在市场上赢得客户的青睐,以及产品的长期发展做出了良好的保障。

3技术文档的要求编辑

技术文档要符合以下要求:
1 针对性
文档编制以前应分清读者对象,按不同的类型、不同层次的读者,决定怎样适应他们的需要。
① 对于面向管理人员和用户的文档,不应像开发文档(面向软件开发人员)那样过多地使用软件的专业术语。 难以避免使用的词汇,应在文档中添加词汇表,进行解释。
② 开发文档使用的专业词汇未被广泛认知的,应添加注释进行说明。
③ 缩写词未被广泛认知的,应在其后跟上完整的拼写。
2 正确性
① 没有错字,漏字。
② 文档间引用关系正确。
③ 文档细节(Title/History)正确。
3 准确性
① 意思表达准确清晰,没有二义性。
② 正确使用标点符号,避免产生歧义。
4 完整性
① 意思表达完整,能找到主语、谓语、宾语,没有省略主语,特别是谓语。
② 一句话中不能出现几个动词一个宾语的现象。
③ 不遗漏要求和必需的信息。
5 简洁性
① 尽量不要采用较长的句子来描述,无法避免时,应注意使用正确的标点符号。
② 简洁明了,不累赘冗余,每个意思只在文档中表达一次。
③ 每个陈述语句,只表达一个意思。
④ 力求简明,如有可能,配以适当的图表,以增强其清晰性。
6 统一性
① 统一采用专业术语和项目规定的术语集。
② 同一个意思和名称,前后描述的用语要一致。
③ 文档前后使用的字体要统一。
④ 同一课题若干文档内容应该协调一致,没有矛盾。
7 易读性
① 文字描述要通俗易懂。
② 前后文关联词使用恰当。
③ 文档变更内容用其他颜色与上个版本区别开来。
④ 测试步骤要采用列表的方式,用1)、2)、3)…等数字序号标注。