分享
 
 
 

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

王朝other·作者佚名  2006-01-09
窄屏简体版  字體: |||超大  

有关文档的实用要求

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

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

怎么样的文档才算实用?

1. 目的明确

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

2. 条理清晰

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

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

3. 一致性

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

4. 内容充实

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

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

5. 可操作性

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

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

6. 体贴

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

 
 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
2023年上半年GDP全球前十五强
 百态   2023-10-24
美众议院议长启动对拜登的弹劾调查
 百态   2023-09-13
上海、济南、武汉等多地出现不明坠落物
 探索   2023-09-06
印度或要将国名改为“巴拉特”
 百态   2023-09-06
男子为女友送行,买票不登机被捕
 百态   2023-08-20
手机地震预警功能怎么开?
 干货   2023-08-06
女子4年卖2套房花700多万做美容:不但没变美脸,面部还出现变形
 百态   2023-08-04
住户一楼被水淹 还冲来8头猪
 百态   2023-07-31
女子体内爬出大量瓜子状活虫
 百态   2023-07-25
地球连续35年收到神秘规律性信号,网友:不要回答!
 探索   2023-07-21
全球镓价格本周大涨27%
 探索   2023-07-09
钱都流向了那些不缺钱的人,苦都留给了能吃苦的人
 探索   2023-07-02
倩女手游刀客魅者强控制(强混乱强眩晕强睡眠)和对应控制抗性的关系
 百态   2020-08-20
美国5月9日最新疫情:美国确诊人数突破131万
 百态   2020-05-09
荷兰政府宣布将集体辞职
 干货   2020-04-30
倩女幽魂手游师徒任务情义春秋猜成语答案逍遥观:鹏程万里
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案神机营:射石饮羽
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案昆仑山:拔刀相助
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案天工阁:鬼斧神工
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案丝路古道:单枪匹马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:与虎谋皮
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:李代桃僵
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:指鹿为马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:小鸟依人
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:千金买邻
 干货   2019-11-12
 
推荐阅读
 
 
 
>>返回首頁<<
 
靜靜地坐在廢墟上,四周的荒凉一望無際,忽然覺得,淒涼也很美
© 2005- 王朝網路 版權所有