软件技术文档的编制方法

《软件技术文档的编制方法》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、维普资讯http://www.cqvip.com计算机与现代化21103年第11期JISUANJIYUXIANDAIHUA总第99期文章编号：10o6-2475(20o3)11-0014-02软件技术文档的编制方法尹红，傅清平(江西师范大学计算中心，江西南昌330027)摘要：阐述了软件产品技术文档的重要性及技术文档的编写方法。关键词：技术文档；准确性；API中图分类号：TP31文献标识码：AMethodofWritingTechnicalDocmnentofSoftwareYINHong，FUQing—ping(CenterofComputer，JiangxiNormalUniver

2、sity，Nanchang330027，Chir~)Ahar~：Thepaperdesc~thetechnicaldocumentimportanceintheproductofsoftware，andthemethodofwritingthetechnicaldoc—ul1ent．Keyw0rds：technicaldocument；accuracy；AP1技术上评价一个文档的经验。这里给出一些可以提0引言高技术文档的准确性的方法：一套优秀的软件产品，必须有一套优秀的技术文把注意力集中在技术事实上，既不要夸大技术含档。拥有优秀而准确的技术文档不仅对公司非常有量，也不能忽略技术指标，只

3、有这样才能够核实这些益，而且也能让客户从中受益，提升软件产品的质量技术是作为技术文档而被编写出来的。技术评价的和公司的信誉。由于产品如何使用在某种程度上要工作并不等同于一般的编辑工作。依赖技术文档的说明，因此技术文档必须十分的准确一定要从技术上核实，在技术文档里编写的程序可靠。使用不准确和已经过时的技术文档对于公司与步骤的准确性，以及在技术文档中使用的图片捕捉的发展会产生一定的阻碍，同样，它也会对客户产生的准确性。消极的影响。一旦客户在使用产品时遇到了问题，若2需求分析不能通过求助于产品的技术文档进行解决，客户就会对这种产品产生怀疑乃至于失去信心，那么，公司的绝大多数技术文档编写者所做

4、的第一件事情就信誉和利益自然而然就会受到损害。这就是不准确是进行分析，而分析工作又可以分为两种：对象分析的或过时的技术文档所带来的危害。以及任务分析。一般情况下，公司的每一个开发小组都拥有一个1．对象分析。在进行对象分析的时候，编写者应或者更多的专业技术文档编写者，这些编写者负责为该明确这份技术文档是针对哪些人的，也就是什么样他们的产品编写出相关的技术文档。然而，并不是所的人会阅读这份技术文档。此外，编写者是否正在为有的公司能拥有专职的技术文档编写者。如果要编公司里别的开发小组编写应用编程接口()文件?写出和软件产品联系在一起的优秀的技术文档，则应别的公司的开发人员是怎么样做的?编写者

5、应该去当注意以下几个问题。了解阅读技术文档的那些人对于产品开发的内部过程了解多少，并且要知道公司内有哪些数据是可以使1制定出一个技术评价核对表用，有哪些数据是不能使用?技术评价核对表能保证技术文档的准确性，因有可能编写者正在为最终使用产品的用户编写此，在编写技术文档之前，必须制定一个技术评价核技术性文档。要弄清楚这些用户是使用计算机的新对表。但许多程序开发设计者以及管理者都缺乏从手还是高手。这些用户是否包括各种不同的类型，或收稿日期：21103．02．10‘作者简介：尹红(1966-)，女，江西瑞金人，江西师范大学计算中心实验师，研究方向：计算机应用。维普资讯http://www.cq

6、vip.com2O03年第11期尹红等：软件技术文档的编制方法15“者他们的背景是否不尽相同呢?如果编写者对这些一套能够帮助软件设计人员让他们开发的软件能够情况并不确定的话，这里提供一些办法能够帮助编写同我们所开发的软件进行对话的工具”，这么写看上者确定这些情况。去很费笔墨，但是，这样却能够让那些没有技术背景(1)和你公司里的服务组或者技术支持小组的成的读者很好地掌握API的含义。员就这些问题进行交谈，这能够通过他们的经验来了对于那些专业技术人员来说，就可以使用专业术解用户的情况。语了(也就是说，可以使用堆栈、线程等词汇)，并且在(2)阅读有关此产品或者类似产品的新闻组以及写出这些词汇

7、的同时，不需要再特别地解释一番。不邮件列表，也可以获得有用的信息。过，如果不确定所使用的一个缩写词是被广泛认可(3)在网络站点上进行问卷调查，或者直接把问的，那么，一定要在后边把这个缩写词解释清楚，并跟卷分发到那些注册过的用户手里来了解情况。上完全的拼写。不要过分使用那些冗长的词汇，尽量不过，在使用上述方法的同时要让这些人明白是使用简单的能够说明问题的措辞，这么做更能够给读在为他们服务，这样才会获得更多的反馈信息。者留下深刻的印象，而不是让读者