软件文档编制注意事项-【香港软件开发】

admin 软件开发 2019-01-12 14:38 0
 
 
  关键词:香港软件开发公司、软件文档编写需要注意什么
 
  软件文档编制是一-个从形成最初轮廓,经反复检查和修改,直到程序和文档正式交付使用的完整过程。要保证文档编制的质量,体现每个项目的特点,在编制文档时就要注意以下几点。
 
  1.清楚定位文档的读者
 
  每个文档都具有特定的读者,这些读者包括开发组成员、管理人员、维护人员或者用户。他们期待着使用这些文档的内容来进行工作,例如设计、编码、测试、使用和维护。因此软件文档的编制应该充分考虑读者的水平、特点和要求。
 
  2.灵活处理应编制的文档种类
 
  针对一个具体的软件开发项目,需要编制的软件文档的种类由软件项目的规模和复杂性决定。对于规模较小的简单的项目,可以把几个文档合并成种。-般地说,当项目的规模、复杂性和成败风险增大时,文档的编制范围和详细程度将随之增加和提高,反之则可适当减少和降低。项目经理应该制订一个文档编制计划,其中包括:应该编写哪些文档;详细程度如何;各个文档的编写负责人和进度要求;评审和批准的负责人和时间进度要求;在开发期间内各文档的维护、修改和管理的责任人和相关手续。
 
  3.明确文档的范围,避免空泛浮躁
 
  香港软件定制开发:任何一个软件文档都有其目的,不是为了写文档而写文档。为了实现该文档的目的,对于文档应该描述哪些内容,应该在文档编制之前进行规划,如果没有对文档内容的规划则势必造成或空泛无物或不知所云的局面。文档内容应该恰到好处,大而全的文档是没有用的,小而不实的文档也毫无用处。本书介绍的各类文档都会给出相应的文档模板及内容要求,在项目具体实施过程中参考执行可有效地避免该问题。
 
  4.规范名词使用,保持前后一致
 
  软件文档中不可避免地要用到一此名词或称谓,首先应尽量使用通用的软件术语进行描述,如果一定要使用非通用或者自己创造的术语,香港软件开发商应该在使用的同时对该术语做出详尽的解释;其次,统一所使用的名词或称谓,防止同一个意思的名词或称谓前后不致,这样会让文档产生歧义。
 
  5.应用图文表格,保证内容清晰
 
  任何自然语言都有产生二义性的可能,简洁的图形和表格胜过千言万语,因此软件文档编制应尽量使用图文表格,比如可以使用UML的各类图形(用例图、类图、对象图和活动图等)来描述软件需求和软件设计,这样可以确保文档内容的清晰、无歧义。
 
  以上就是软件文档编制注意事项-【香港软件开发】全文,希望对大家有所帮助!

分享:

扫一扫在手机阅读、分享本文

发表评论

评论列表(条)