有关文档的实用性要求——来自《文档审核意见-关于xx文档》的摘录

原创 2004年10月28日 15:50:00

有关文档的实用要求<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

1.       文档不仅仅是给客户的,也是我们此次工程实施的经验总结;

2.       文档必须要实用,为了客户,也为了我们自己!

怎么样的文档才算实用?

1.       目的明确

a)        文档肯定是针对某类问题的说明,因此要求目的明确,针对性强。比如若仅是针对某个模块其中一个版本的说明,则决不含糊其辞,而是在很明显的地方与以说明,决不浪费使用者/读者的时间。

2.       条理清晰

a)        尽可能地以读者角度/思路来合理编排章节;

b)        讲清楚:是什么?为什么?怎么做?等几个问题,必要时还需要增加“谁?”“何时?何地?何种情况?”等一些问题。

3.       一致性

a)        在文中多次出现的有关内容,应该前后描述一致,不自相矛盾;

4.       内容充实

a)        就某个问题的描述,应该言之有物而不夸夸其谈;

b)        若实在没东西讲,应该写明“内容有待细化/补充”;

5.       可操作性

a)        如果文档的特点是针对操作开展,则应该在内容的真实性、可验证性上做足文章。读者能够根据文档的提示一步步完成某项工作;

b)        文档应该尽可能地提供可视化的图片或其他媒体方式,以便内容直观,更易于理解;

6.       体贴

a)        在文中出现对有关内容的引述,应该尽可能提供链接,以免读者四处搜索遍寻不着;

app审核文档——审核中会遇到的问题

通过它,我们希望帮助您解决开发应用程序时遇到的问题,以便于您在提交应用程序时,可以加快审批流程的速度。 我们将应用程序(Apps)视为与书籍或歌曲不同的产品,我们并不存储它们。如果您意欲批评宗教...
  • iOS_yanmy
  • iOS_yanmy
  • 2016年12月16日 16:01
  • 562

编写自文档化代码

创建优秀的代码意味着创建良好的文档化了的代码。我们编写代码的原因是要表达一套清晰的指令——不仅仅是对电脑,也是对那些以后需要维护或拓展这些指令的可怜傻瓜们。...
  • YhL_Leo
  • YhL_Leo
  • 2016年01月19日 21:27
  • 1222

SOCKET编程的详细电子文档

第二章 socket编程原理  2.1 问题的引入  UNIX系统的I/O命令集,是从Maltics和早期系统中的命令演变出来的,其模式为打开一读/写一关闭(open-write-read-clo...
  • xjbclz
  • xjbclz
  • 2016年07月13日 21:50
  • 670

敏捷开发需要编写文档吗?

在产品研发过程中经常需要编写很多文档,而敏捷宣言的第二条“可工作的软件胜于详尽的文档",那么需要编写文档吗?有没有简单的判断方法呢?...
  • zzhdi
  • zzhdi
  • 2016年03月19日 10:39
  • 1099

有关文档碎片(document fragment)的用法

通常情况下修改、删除或者增加DOM元素。更新DOM会导致浏览器重新绘制屏幕,也会导致reflow,这样会带来巨大的开销。我们通常解决这的办法尽量减少更新DOM,这也就意味着将DOM的改变分批处理,并在...
  • yilanyoumeng3
  • yilanyoumeng3
  • 2015年06月10日 09:41
  • 2351

Jacob 操作Word文档示例

package king.word; import com.jacob.activeX.ActiveXComponent; import com.jacob.com.Dispatch; import...
  • kinglearnjava
  • kinglearnjava
  • 2015年01月22日 01:50
  • 803

如何写好一份产品需求文档

如何写好一份产品需求文档 PRD写得好看还不如需求把握得准确,PRD写得好看还不如体验设计得顺畅。 工欲善其事必先利其器。 产品需求文档(以下都简称PRD)对于大多数产品新人来说都并不陌...
  • terry198608
  • terry198608
  • 2017年01月24日 15:52
  • 1257

dedecms中用SQL语句清除数据库中待审核的文档

dedecms中用SQL语句清除数据库中待审核的文档 在dede后台 系统-》SQL命令行工具运行下以命令即可(注意,运行后未审核的数据全被删除,小心使用) dele...
  • sgkxfnd
  • sgkxfnd
  • 2015年01月08日 11:51
  • 293

使用oracle官方文档(11G)——初探Concept

chushi
  • huangyanlong
  • huangyanlong
  • 2014年07月26日 16:35
  • 2301

使用Lucene对图书馆构建Document(文档)和Field(字段)

搜索引擎
  • u012965373
  • u012965373
  • 2015年03月18日 21:19
  • 1239
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:有关文档的实用性要求——来自《文档审核意见-关于xx文档》的摘录
举报原因:
原因补充:

(最多只允许输入30个字)