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

TC十大黄金法则之解读

(2012-01-25 18:39:14)
标签:

stc

技术写作

it

分类: 技术写作概论
以下是我对这些法则和解读:

1.Paper is permanent. 写下来的东西会一直存在。设想某一天你翻看以前写的文档,看到一个个低级错误蹦出来,你不禁面红耳赤:写的时候怎么就没发现呢?!要杜绝这些低级错误,不仅要对词语拼写、语法、句法、标点烂熟于心,还需熟悉所使用的写作规范。可以利用工具作为辅助手段:拼写检查工具、编辑辅助工具,甚至将写作规范的某些内容设置成写作工具中的格式规则来执行。另外还需要作者反复校对修改。Writing is about rewriting. 反复锤炼才能得精品。
2.Know your audience. 只有熟悉了目标读者,才能奠定文档基调。试问以下问题:读者主要从事哪些职业?担当哪些角色?专业水平如何?期望从本文档中得到哪些信息?从每个读者群中抽取一个典型的读者样本,建立其基本信息 (persona),如system administrator。
3.Make hazards stand out. 将告警信息(如“危险”、“警告”、“注意”等内容)与正文分开,并放在适当的位置,如操作步骤之前。
4.Break it out. 这就类似于Information Mapping 里的chunking、labeling等技术,即把信息分类,按一定的逻辑排序,并用恰当的表现方式视觉化呈现。为什么要强调“视觉化”?因为很多人写文档有个误区,认为写文档就一定是“写”,却忽略了很多别的表现方式,如列表、表格、图表等。无论采取什么形式,目的只有一个:便于读者理解。
5.Do not write blind. 这个说起来容易做起来难。一句话:把自己当成真正的使用者去体验产品。问问题也是一个技术活,不要漏掉任何一个细节。
6.Be consistent. 不光术语要一致,起码要保证同一本手册内的风格也一致。相同的内容要尽量用相同的表达方法。
7.Signpost. 使用目录、索引、交叉链接等方法方便读者找到所需内容。很多人不重视索引,对于读者来说,索引是找到信息的一个重要手段。
8.Do not violate the standards. 写法符合标准或写作规范。
9.Contemplate before illustrate. 图形要注意分辨率、格式等问题。为了便于本地化,尽量用数字而不是文字作标注,再在正文中用文字对数字标注一一作解释。
10.Cut the fluff. 去掉冗余内容,避免出现歧义或语意模糊。写文档时能写则写;检阅文档时则需要精简内容。

0

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

    发评论

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

      

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

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

    新浪公司 版权所有