没有合适的资源?快使用搜索试试~ 我知道了~
每个开发团队都需要进行文档的编写,作为开发团队中的文档编写者,你应该看看....
资源详情
资源评论
资源推荐
开发团队中的文档编写者
一般情况下,每一个开发小组都拥有一个或者更多的专业技术文档编写者,这些编写者负责为他们的产品编写出相关的技术文档。然而,并不是
所有的公司能拥有专职的技术文档编写者。如果你必须编写出和你的软件产品联系在一起的技术文档的时候,你应该在你的脑子里记住下面的这些必
须进行的事情。
需要进行分析
绝大多数技术文档编写者所做的第一件事情就是进行分析,而分析工作又可以分为两种:对象分析以及任务分析。
对象分析
在进行对象分析的时候,你应该明确这份技术文档是针对哪些人的,也就是什么样的人会阅读你的这份技术文档。此外,你是否正在为公司里别
的开发小组编写应用编程接口(API)文件么?别的公司的开发人员是怎么样做的?你应该去了解阅读你所编写技术文档的那些人对于产品开发的内部过
程了解多少,并且要知道公司内有哪些数据你可以使用,有哪些你不能使用?
有可能你正在为最终使用产品的用户编写技术性文档。你要弄清楚这些用户是使用计算机的菜鸟还是高手。这些用户是否包括各种不同的类型,
或者他们的背景是否要不尽相同呢?如果你对这些情况并不确定的话,这里有一些办法能够帮助你确定这些情况。和你公司里的服务组或者技术支持
小组的成员就这些问题进行交谈,这能够帮助你通过他们的经验来了解那些用户的情况。阅读有关此产品或者类似产品的新闻组以及邮件列表也可以
让你获得有用的信息。你甚至可以在你们的网络站点上进行问卷调查,或者直接把问卷分发到那些注册过的用户手里来了解情况。不过,在这么做的
同时要让这些人明白你是在为他们服务,这样才会获得更多的反馈。
任务分析
任务分析包括对读者将会如何使用这些技术文档进行分析。这份技术文档是为了指导用户如何安装软件产品而编写的么?如果是这样,你就要把精
力集中在安装过程中每一步骤的上面。是否是为了方便其他编程者而编写的应用编程接口(API)文件?在这种情况下,你可能会需要一种基准格式来把
应用编程接口(API)组件分解成逻辑排列的一些形式,这就让需要阅读这份文件的程序开发设计人员能够轻松的从中获得他们所需要的东西。
有些时候,把任务和相关参考文献结合在一起是一种更好的办法。在指导说明中可以包含参考文献部分,并且这是作为独立的内容而附加在指导
说明上边的。另一些好办法是在这种指导说明中加入技巧、警告、注释、表、数据以及其它的一些内容,这样你就可以更生动的描述相关的内容,单
纯的动用大量的文字很容易让读者产生沉闷的感觉。
在技术文档中加入图形注释
在技术文档中加入技巧和警告内容是非常重要的,这样能够避免让你的读者产生和别的指导说明书或者参考材料混淆的感觉。看一看别人编写的
手册或者技术说明书,你就能够获得大量的范例。典型的情况是,在你所添加的技巧和警告周围加上边框,或者用醒目的下划线标注出来,对你的读
者来说都是很有帮助的。在文章中加入图形也是一种好办法,尤其是你在向读者对某些事情进行警告的时候,图形化的内容能够让你所警告的东西变
得更清晰让能够产生深刻的印象。
注意技术文档的措辞
对于技术性文档来说,另一个重要的方面就是你的措辞。如果你的文档所针对的对象是入门者或者没有技术背景的人,你必须对你的这些读者所
拥有的知识进行分析,这是十分基本而且重要的。因为你不知道这些读者对你所引用的缩写词汇是否真的明白。为了避免你的读者对这些词汇感到头
merry_2
- 粉丝: 2
- 资源: 1
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0