加载中…
个人资料
NightWriter
NightWriter
  • 博客等级:
  • 博客积分:0
  • 博客访问:10,078
  • 关注人气:44
  • 获赠金笔:0支
  • 赠出金笔:0支
  • 荣誉徽章:
相关博文
推荐博文
谁看过这篇博文
加载中…
正文 字体大小:

如何提高文档的易检索性?

(2012-03-24 16:56:31)
标签:

技术沟通

技术写作

用户体验

分类: 技术写作概论

我们常常听到对用户手册的一个抱怨是,“内容太多了,就是找不到需要的”。遗憾的是,作者在内容方面做了很多工作,却因为编排不到位,无法满足读者需求。Developing Quality Technical Information一书提出高质量的技术文档需要做到易用、易懂、易检索(easy to use, easy to understand, easy to find)。易检索就是指读者能够方便地找到想看的内容。

这是我总结的一些提高手册易检索性的方法:

1、 整个手册的内容结构清晰,布局合理,章节按一定逻辑排列。

2、不同性质的内容要分开,用明显的标记列出。例如,描述、步骤、参考等。特别要标注出一些需要引起读者注意的内容(如警示、注意、提示等)。

3、 引用手册中别处的内容时要准确,最好用交叉链接。

4、 章节标题要简洁,能准确概括内容。

5、不要忽略索引。索引是一项重要工作。读者通常首先在目录中找内容,找不到就会到索引中找。(具体见做索引需要注意哪几点?

6、 为在线文档做书签(bookmark)和全文索引(full-text index)。书签可以方便跳到不同章节。如果提供多个手册,全文索引可以直接在多个手册间查找关键词。

7、纸质文档尤其要注意页面的设计,通常需要在页眉注明手册名和章节名,页脚注明页码。

8、 一个产品有多个手册时,在各手册中列出相关手册及与其关系。

 

附:做索引需要注意哪几点?

一个索引词条包括两部分:关键词(keyword)和定位词(locator),说白了就是要找的内容和页码。一个主词条下面可以有多个副词条。

做索引首先要对文档内容相当熟悉,做索引的过程就是从读者角度对文档进行检视,猜测读者可能想寻找的关键词。

做索引时要注意以下几点:

·索引词条不要超过三层,内容复杂的概念可以考虑将某一层另立主词条。

·名词当前。主词条通常是名词。

·用具体的动词,如creating, installing等,避免用using, making等太笼统的词。

·不要在索引中重复标题内容。做索引时要考虑标题,因为标题中包含很多关键词。但不能只用标题,手册中还有很多标题未涉及的概念。正文、脚注、表格、图表中都有与概念相关的内容,都可以做成索引词条。

记住,像用户一样思考。

 

索引示例:

如何提高文档的易检索性?

0

阅读 评论 收藏 转载 喜欢 打印举报/Report
  • 评论加载中,请稍候...
发评论

    发评论

    以上网友发言只代表其个人观点,不代表新浪网的观点或立场。

      

    新浪BLOG意见反馈留言板 电话:4000520066 提示音后按1键(按当地市话标准计费) 欢迎批评指正

    新浪简介 | About Sina | 广告服务 | 联系我们 | 招聘信息 | 网站律师 | SINA English | 会员注册 | 产品答疑

    新浪公司 版权所有