写文档的一些技巧

标签: 文档 技巧 | 发表时间:2011-05-19 07:01 | 作者:小强 yifei
出处:http://ucdchina.com/rss/all

最近带一个毕业生,他让我对文档的撰写有了一些新的领悟,跟以前的结合起来一起说一下:

首先,我个人在写文档方面有2个特点:简洁,清晰

简洁:能用一句话说清楚的绝不用第二句,用最简单的句子

清晰:结构清晰,让人一目了然;逻辑清晰,尽量减少读者的理解成本;重点清晰。

对内的文档

对上级:由于上级的时间都很宝贵,所以对上级的文档建议使用“金字塔原理”(《金字塔原理》是一本很不错的书,推荐阅读)。先用简练的开头让老大知道整个文档的核心内容(分析结果、方案概述…),然后再阐述细节,说明理由。

对下级:大部分都是执行层面,所以文档要强调执行的目的,完成时间,谁来做,做到什么程度,需要注意什么…

跨部门:大部分都是需求类文档,要强调制作需求目的,需求实现的各种细节,测试时间,更新时间…

对外的文档

对于活动策划来说,对外的文档主要就是活动公告了,这也是今天想说的重点。

【结构】

活动标题、活动引言、活动时间、活动范围、活动奖励、活动内容、活动说明。

这几个部分缺一不可,顺序没有定式,始终如一即可。由于大部分活动文档都是用这种结构,所以制作一个活动文档的模板是十分有必要的,能够节省很多时间。

【重点】

语言简洁,不说废话,同时要突出重点跟。跟玩家参与活动有关的都是重点(5W1H),这些重点尽量用颜色区分,但是不同的颜色不要过多,多于3种以上的颜色就很难看。

我一般在奖励(红色)和NPC(蓝色)上用颜色区分,时间由于是独立的一部分所以不用颜色。

【逻辑】

大部分活动都没有很复杂的逻辑(如果大部分活动的逻辑都很复杂,那么这个活动策划就是失败的,他的活动方案“拦住了”很多玩家参与活动),我们可以是用上面的结构。

但是有时候因为某些功能无法实现,或者为了增加乐趣性,我们选择了较复杂的活动逻辑和流程。这个时候,使用上面的结构就不是明智之选了。当你按照上面的结构写完,让一个不了解活动的同事来瞅瞅,发肯定会告诉你:第一他不愿意看,因为字太多,第二他不容易看懂,因为活动内容和活动说明这2个部分的逻辑会错综复杂。

面对较复杂的活动,我建议使用玩家的行为逻辑。目的都是为了让玩家知道“我要做什么”!

活动概述:

最简洁的语言说明活动的核心内容,活动奖励,活动范围。(同样是金字塔原理)

流程图:

图形化的手段降低理解成本。流程图中的内容为玩家行为(如果活动流程中存在官方人员的工作内容,去掉它,只保留玩家必须要知道的内容)

流程详情:

每一步流程都包括时间,内容,其他说明。

逻辑复杂的活动公告

【修饰】

加入活动奖励图片:把奖励的文字标红,远不如加入奖励图片来的好。

加入跟活动主题贴切的图片:这个图片是用来传递情感的,比如在母亲节活动的公告中加入一张体现关爱母亲的图片能更有感染力。

活动引言:以前我最不爱写这部分,但是现在觉得这个引言也很重要,因为他体现了一种风格,就跟人的个性一样,这部分文字能让突出游戏的风格特点。比如你是一个三国背景的游戏,引言就可以加入一些典故。

不要觉得图片一定比文字好:以前我曾迷信图片一定优于文字,所以有一阵尝试了在所有的活动公告中都加入一些流程图(包括逻辑简单的活动),但是发现图片无法精确的表达细节,容易误导玩家。所以简单的活动不要用图片,加入图片反而变得复杂化,复杂的活动再加入流程图。

【当局者迷】

由于活动方案都是我们想出来的,整个活动都是我们自己的逻辑,所以我们不存在理解问题。

另外,做方案时,我们会设计好玩家的行为方式,其他行为方式可能会被我们所疏忽。

基于以上2点原因,我们写出来的文档可能会让玩家难以理解。所以我们在写好文档后,最好找一个对活动方案不了解的同事,让他看一遍,是否存在理解困难问题,或者哪些地方玩家可能钻空子。

听取局外人的意见,对文档进行最终修改,这样的文档才能成为玩家喜欢的文档,而不是我们自己喜欢的文档!

源地址:http://xiaoqiang.me/?p=1902

相关 [文档 技巧] 推荐:

写文档的一些技巧

- yifei - 所有文章 - UCD大社区
最近带一个毕业生,他让我对文档的撰写有了一些新的领悟,跟以前的结合起来一起说一下:. 首先,我个人在写文档方面有2个特点:简洁,清晰. 简洁:能用一句话说清楚的绝不用第二句,用最简单的句子. 清晰:结构清晰,让人一目了然;逻辑清晰,尽量减少读者的理解成本;重点清晰. 对上级:由于上级的时间都很宝贵,所以对上级的文档建议使用“金字塔原理”(《金字塔原理》是一本很不错的书,推荐阅读).

Hadoop MapReduce技巧

- - 简单文本
我在使用Hadoop编写MapReduce程序时,遇到了一些问题,通过在Google上查询资料,并结合自己对Hadoop的理解,逐一解决了这些问题. Hadoop对MapReduce中Key与Value的类型是有要求的,简单说来,这些类型必须支持Hadoop的序列化. 为了提高序列化的性能,Hadoop还为Java中常见的基本类型提供了相应地支持序列化的类型,如IntWritable,LongWritable,并为String类型提供了Text类型.

WordPress 技巧

- - CSDN博客互联网推荐文章
WordPress字体设置方法详解.          WordPress开源程序功能越来越强大,未来我们不仅仅可以使用wordpress制作个人博客,还可以使用wordpress程序制作CMS内容管理系统. 很多 Wordpress主题SEO优化的非常好,而且还附带了一些adsense广告位置,让不懂SEO以及代码修改的朋友轻松解决博客优化以及广告位放置问题.

javascript技巧

- - ITeye博客
oncontextmenu="window.event.returnValue=false"  将彻底屏蔽鼠标右键. < table border oncontextmenu=return(false)>< td>no< /table>  可用于Ta bl e. < body onselectstart="return false">  取消选取、防止复制.

linux 小技巧

- - DBA Blog
2:如何限制用户的最小密码长度. 修改/etc/login.defs里面的PASS_MIN_LEN的值. 比如限制用户最小密码长度是8:. 3:如何使新用户首次登陆后强制修改密码. 4:更改Linux启动时用图形界面还是字符界面. 将id:5:initdefault: 其中5表示默认图形界面. 改id:3: initdefault: 3表示字符界面.

面试技巧

- - 非技术 - ITeye博客
问题一:“请你自我介绍一下” .   1、这是面试的必考题目.   2、介绍内容要与个人简历相一致.   3、表述方式上尽量口语化.   4、要切中要害,不谈无关、无用的内容.   5、条理要清晰,层次要分明.   6、事先最好以文字的形式写好背熟. 问题二:“谈谈你的家庭情况” .   1、 况对于了解应聘者的性格、观念、心态等有一定的作用,这是招聘单位问该问题的主要原因.

HTML5 & CSS3 研究文档

- Kings - 幸福收藏夹
已经说了好久,一直没把这个文件夹分享出来. 这是我去年第四季度里做的,里面有 11 一个文档. 包括 HTML5 中最主要的 JS API 文档,还有 CSS3 中两个比较难的属性. 主要还停留在纯 API 层面上的研究,没有深入到应用中去. 不过,当做工具来使用,和入门文档,还是不错的. 特别是其中的 HTML5 JS API 文档.

Twitter API中文文档

- Jacob - 月光博客
  目前的国内的微博客很多,不少微博客都提供Open API,然而,很多微博提供的API和Twitter的API有一些或多或少的差别,调用格式上并不完全相同.   我建议所有提供API的微博客系统,都将各自的API统一为Twitter的API调用格式,例如目前较有影响的开源微博系统StatusNet(Laconica)的API格式就完全兼容Twitter,这种统一API对于开发者和用户都有很大的好处.

Underscore.js Version (1.2.3) 中文文档

- - WEB前端开发
Underscore 一个非常实用的JavaScript库,提供许多编程功能的支持,就像你期望 Prototype.js (或者 Ruby), 有这些功能且不扩展任何JavaScript的原生对象. 有函数式编程的风格,还支持链式调用. 主要涉及对Collection、Object、Array、Function的操作,还有一些实用方法.

Redis集群明细文档

- - CSDN博客架构设计推荐文章
  Redis目前版本是没有提供集群功能的,如果要实现多台Redis同时提供服务只能通过客户端自身去实现(Memchached也是客户端实现分布式). 目前根据文档已经看到Redis正在开发集群功能,其中一部分已经开发完成,但是具体什么时候可以用上,还不得而知. 文档来源: http://redis.io/topics/cluster-spec.