王朝百科
分享
 
 
 

技术文档

王朝百科·作者佚名  2010-10-25  
宽屏版  字体: |||超大  

英文称为Technical Documentation

从业者称为Technical writer

技术文档分两类,一类指开发中要用到的研发文档,一类是给客户看的客户文档。

研发文档指研发过程中使用的文档。英文一般称为Specification。

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

客户文档指产品发布以后,公布给用户使用的文档。英文一般称为Customer Documentation。

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

技术文档的要求技术文档要符合以下要求:

1 针对性

文档编制以前应分清读者对象,按不同的类型、不同层次的读者,决定怎样适应他们的需要。

① 对于面向管理人员和用户的文档,不应像开发文档(面向软件开发人员)那样过多地使用软件的专业术语。 难以避免使用的词汇,应在文档中添加词汇表,进行解释。

② 开发文档使用的专业词汇未被广泛认知的,应添加注释进行说明。

③ 缩写词未被广泛认知的,应在其后跟上完整的拼写。

2 正确性

① 没有错字,漏字。

② 文档间引用关系正确。

③ 文档细节(Title/History)正确。

3 准确性

① 意思表达准确清晰,没有二义性。

② 正确使用标点符号,避免产生歧义。

4 完整性

① 意思表达完整,能找到主语、谓语、宾语,没有省略主语,特别是谓语。

② 一句话中不能出现几个动词一个宾语的现象。

③ 不遗漏要求和必需的信息。

5 简洁性

① 尽量不要采用较长的句子来描述,无法避免时,应注意使用正确的标点符号。

② 简洁明了,不累赘冗余,每个意思只在文档中表达一次。

③ 每个陈述语句,只表达一个意思。

④ 力求简明,如有可能,配以适当的图表,以增强其清晰性。

6 统一性

① 统一采用专业术语和项目规定的术语集。

② 同一个意思和名称,前后描述的用语要一致。

③ 文档前后使用的字体要统一。

④ 同一课题若干文档内容应该协调一致,没有矛盾。

7 易读性

① 文字描述要通俗易懂。

② 前后文关联词使用恰当。

③ 文档变更内容用其他颜色与上个版本区别开来。

④ 测试步骤要采用列表的方式,用1)、2)、3)…等数字序号标注。

 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
如何用java替换看不见的字符比如零宽空格​十六进制U+200B
 干货   2023-09-10
网页字号不能单数吗,网页字体大小为什么一般都是偶数
 干货   2023-09-06
java.lang.ArrayIndexOutOfBoundsException: 4096
 干货   2023-09-06
Noto Sans CJK SC字体下载地址
 干货   2023-08-30
window.navigator和navigator的区别是什么?
 干货   2023-08-23
js获取referer、useragent、浏览器语言
 干货   2023-08-23
oscache遇到404时会不会缓存?
 干货   2023-08-23
linux下用rm -rf *删除大量文件太慢怎么解决?
 干货   2023-08-08
刀郎新歌破世界纪录!
 娱乐   2023-08-01
js实现放大缩小页面
 干货   2023-07-31
生成式人工智能服务管理暂行办法
 百态   2023-07-31
英语学习:过去完成时The Past Perfect Tense举例说明
 干货   2023-07-31
Mysql常用sql命令语句整理
 干货   2023-07-30
科学家复活了46000年前的虫子
 探索   2023-07-29
英语学习:过去进行时The Past Continuous Tense举例说明
 干货   2023-07-28
meta name="applicable-device"告知页面适合哪种终端设备:PC端、移动端还是自适应
 干货   2023-07-28
只用css如何实现打字机特效?
 百态   2023-07-15
css怎么实现上下滚动
 干货   2023-06-28
canvas怎么画一个三角形?
 干货   2023-06-28
canvas怎么画一个椭圆形?
 干货   2023-06-28
canvas怎么画一个圆形?
 干货   2023-06-28
canvas怎么画一个正方形?
 干货   2023-06-28
中国河南省郑州市金水区蜘蛛爬虫ip大全
 干货   2023-06-22
javascript简易动态时间代码
 干货   2023-06-20
感谢员工的付出和激励的话怎么说?
 干货   2023-06-18
 
>>返回首页<<
 
 
 
静静地坐在废墟上,四周的荒凉一望无际,忽然觉得,凄凉也很美
© 2005- 王朝网络 版权所有