MyException - 我的异常网
当前位置:我的异常网» 编程 » 软件工程师与架构师的差别之文档的思维方式(老开发

软件工程师与架构师的差别之文档的思维方式(老开发感悟)

www.MyException.Cn  网友分享于:2013-10-25  浏览:2次
程序员与架构师的差别之文档的思维方式(老开发感悟)

最近带一个毕业生,他让我对文档的撰写有了一些新的领悟,跟以前的结合起来一起说一下:
首先,我个人在写文档方面有2个特点:简洁,清晰
简洁:能用一句话说清楚的绝不用第二句,用最简单的句子
清晰:结构清晰,让人一目了然;逻辑清晰,尽量减少读者的理解成本;重点清晰。
对内的文档
对上级:由于上级的时间都很宝贵,所以对上级的文档建议使用“金字塔原理”(《金字塔原理》是一本很不错的书,推荐阅读)。先用简练的开头让老大知道整个文档的核心内容(分析结果、方案概述…),然后再阐述细节,说明理由。
对下级:大部分都是执行层面,所以文档要强调执行的目的,完成时间,谁来做,做到什么程度,需要注意什么…
跨部门:大部分都是需求类文档,要强调制作需求目的,需求实现的各种细节,测试时间,更新时间…
对外的文档
对于活动策划来说,对外的文档主要就是活动公告了,这也是今天想说的重点。
【结构】
活动标题、活动引言、活动时间、活动范围、活动奖励、活动内容、活动说明。
这几个部分缺一不可,顺序没有定式,始终如一即可。由于大部分活动文档都是用这种结构,所以制作一个活动文档的模板是十分有必要的,能够节省很多时间。
【重点】
语言简洁,不说废话,同时要突出重点跟。跟玩家参与活动有关的都是重点(5W1H),这些重点尽量用颜色区分,但是不同的颜色不要过多,多于3种以上的颜色就很难看。
我一般在奖励(红色)和NPC(蓝色)上用颜色区分,时间由于是独立的一部分所以不用颜色。
【逻辑】
大部分活动都没有很复杂的逻辑(如果大部分活动的逻辑都很复杂,那么这个活动策划就是失败的,他的活动方案“拦住了”很多玩家参与活动),我们可以是用上面的结构。
但 是有时候因为某些功能无法实现,或者为了增加乐趣性,我们选择了较复杂的活动逻辑和流程。这个时候,使用上面的结构就不是明智之选了。当你按照上面的结构 写完,让一个不了解活动的同事来瞅瞅,发肯定会告诉你:第一他不愿意看,因为字太多,第二他不容易看懂,因为活动内容和活动说明这2个部分的逻辑会错综复 杂。
面对较复杂的活动,我建议使用玩家的行为逻辑。目的都是为了让玩家知道“我要做什么”!
活动概述:
最简洁的语言说明活动的核心内容,活动奖励,活动范围。(同样是金字塔原理)
流程图:
图形化的手段降低理解成本。流程图中的内容为玩家行为(如果活动流程中存在官方人员的工作内容,去掉它,只保留玩家必须要知道的内容)
流程详情:
每一步流程都包括时间,内容,其他说明。

【修饰】
加入活动奖励图片:把奖励的文字标红,远不如加入奖励图片来的好。
加入跟活动主题贴切的图片:这个图片是用来传递情感的,比如在母亲节活动的公告中加入一张体现关爱母亲的图片能更有感染力。
活动引言:以前我最不爱写这部分,但是现在觉得这个引言也很重要,因为他体现了一种风格,就跟人的个性一样,这部分文字能让突出游戏的风格特点。比如你是一个三国背景的游戏,引言就可以加入一些典故。
不要觉得图片一定比文字好:以前我曾迷信图片一定优于文字,所以有一阵尝试了在所有的活动公告中都加入一些流程图(包括逻辑简单的活动),但是发现图片无法精确的表达细节,容易误导玩家。所以简单的活动不要用图片,加入图片反而变得复杂化,复杂的活动再加入流程图。
【当局者迷】
由于活动方案都是我们想出来的,整个活动都是我们自己的逻辑,所以我们不存在理解问题。
另外,做方案时,我们会设计好玩家的行为方式,其他行为方式可能会被我们所疏忽。
基于以上2点原因,我们写出来的文档可能会让玩家难以理解。所以我们在写好文档后,最好找一个对活动方案不了解的同事,让他看一遍,是否存在理解困难问题,或者哪些地方玩家可能钻空子。
听取局外人的意见,对文档进行最终修改,这样的文档才能成为玩家喜欢的文档,而不是我们自己喜欢的文档!

1 楼 yeiccie 2011-08-02  
对我来说,写文档是件很痛苦的事,把这么痛苦的事分析的这么透彻应该是更痛苦的事。一般我都是照模板改,从来没有分析过给不同的人还要有不同的格式,好辛苦啊。

文章评论

做程序猿的老婆应该注意的一些事情
做程序猿的老婆应该注意的一些事情
程序员应该关注的一些事儿
程序员应该关注的一些事儿
程序员都该阅读的书
程序员都该阅读的书
看13位CEO、创始人和高管如何提高工作效率
看13位CEO、创始人和高管如何提高工作效率
程序员最害怕的5件事 你中招了吗?
程序员最害怕的5件事 你中招了吗?
老美怎么看待阿里赴美上市
老美怎么看待阿里赴美上市
我是如何打败拖延症的
我是如何打败拖延症的
编程语言是女人
编程语言是女人
聊聊HTTPS和SSL/TLS协议
聊聊HTTPS和SSL/TLS协议
程序员和编码员之间的区别
程序员和编码员之间的区别
60个开发者不容错过的免费资源库
60个开发者不容错过的免费资源库
程序员周末都喜欢做什么?
程序员周末都喜欢做什么?
为啥Android手机总会越用越慢?
为啥Android手机总会越用越慢?
Web开发者需具备的8个好习惯
Web开发者需具备的8个好习惯
团队中“技术大拿”并非越多越好
团队中“技术大拿”并非越多越好
我的丈夫是个程序员
我的丈夫是个程序员
那些争议最大的编程观点
那些争议最大的编程观点
Java程序员必看电影
Java程序员必看电影
写给自己也写给你 自己到底该何去何从
写给自己也写给你 自己到底该何去何从
科技史上最臭名昭著的13大罪犯
科技史上最臭名昭著的13大罪犯
程序员眼里IE浏览器是什么样的
程序员眼里IE浏览器是什么样的
当下全球最炙手可热的八位少年创业者
当下全球最炙手可热的八位少年创业者
十大编程算法助程序员走上高手之路
十大编程算法助程序员走上高手之路
“肮脏的”IT工作排行榜
“肮脏的”IT工作排行榜
10个帮程序员减压放松的网站
10个帮程序员减压放松的网站
为什么程序员都是夜猫子
为什么程序员都是夜猫子
程序员的鄙视链
程序员的鄙视链
5款最佳正则表达式编辑调试器
5款最佳正则表达式编辑调试器
漫画:程序员的工作
漫画:程序员的工作
初级 vs 高级开发者 哪个性价比更高?
初级 vs 高级开发者 哪个性价比更高?
如何区分一个程序员是“老手“还是“新手“?
如何区分一个程序员是“老手“还是“新手“?
“懒”出效率是程序员的美德
“懒”出效率是程序员的美德
不懂技术不要对懂技术的人说这很容易实现
不懂技术不要对懂技术的人说这很容易实现
程序员的一天:一寸光阴一寸金
程序员的一天:一寸光阴一寸金
Web开发人员为什么越来越懒了?
Web开发人员为什么越来越懒了?
我跳槽是因为他们的显示器更大
我跳槽是因为他们的显示器更大
程序猿的崛起——Growth Hacker
程序猿的崛起——Growth Hacker
Java 与 .NET 的平台发展之争
Java 与 .NET 的平台发展之争
亲爱的项目经理,我恨你
亲爱的项目经理,我恨你
每天工作4小时的程序员
每天工作4小时的程序员
如何成为一名黑客
如何成为一名黑客
一个程序员的时间管理
一个程序员的时间管理
 程序员的样子
程序员的样子
10个调试和排错的小建议
10个调试和排错的小建议
鲜为人知的编程真相
鲜为人知的编程真相
软件开发程序错误异常ExceptionCopyright © 2009-2015 MyException 版权所有