`

写产品说明文档的一些技巧

 
阅读更多



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

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

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

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

  对内的文档

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

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

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

  对外的文档

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

  【结构】

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

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

  【重点】

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

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

  【逻辑】

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

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

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

  活动概述:

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

  流程图:

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

  流程详情:

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

  




  【修饰】

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

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

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

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

  【当局者迷】

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

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

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

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

相关推荐

    ysoserial-master.zip

    ysoserial是一个用于生成利用不安全的Java对象反序列化的有效负载的概念验证工具。它包含一系列在常见Java库中发现的"gadget chains",可以在特定条件下利用执行不安全的反序列化操作的Java应用程序。ysoserial项目最初在2015年AppSecCali会议上提出,包含针对Apache Commons Collections(3.x和4.x版本)、Spring Beans/Core(4.x版本)和Groovy(2.3.x版本)的利用链

    zigbee CC2530无线自组网协议栈系统代码实现协调器与终端的TI Sensor实验和Monitor使用.zip

    1、嵌入式物联网单片机项目开发例程,简单、方便、好用,节省开发时间。 2、代码使用IAR软件开发,当前在CC2530上运行,如果是其他型号芯片,请自行移植。 3、软件下载时,请注意接上硬件,并确认烧录器连接正常。 4、有偿指导v:wulianjishu666; 5、如果接入其他传感器,请查看账号发布的其他资料。 6、单片机与模块的接线,在代码当中均有定义,请自行对照。 7、若硬件有差异,请根据自身情况调整代码,程序仅供参考学习。 8、代码有注释说明,请耐心阅读。 9、例程具有一定专业性,非专业人士请谨慎操作。

    YOLO算法-自卸卡车-挖掘机-轮式装载机数据集-2644张图像带标签-自卸卡车-挖掘机-轮式装载机.zip

    YOLO系列算法目标检测数据集,包含标签,可以直接训练模型和验证测试,数据集已经划分好,包含数据集配置文件data.yaml,适用yolov5,yolov8,yolov9,yolov7,yolov10,yolo11算法; 包含两种标签格:yolo格式(txt文件)和voc格式(xml文件),分别保存在两个文件夹中,文件名末尾是部分类别名称; yolo格式:<class> <x_center> <y_center> <width> <height>, 其中: <class> 是目标的类别索引(从0开始)。 <x_center> 和 <y_center> 是目标框中心点的x和y坐标,这些坐标是相对于图像宽度和高度的比例值,范围在0到1之间。 <width> 和 <height> 是目标框的宽度和高度,也是相对于图像宽度和高度的比例值; 【注】可以下拉页面,在资源详情处查看标签具体内容;

    Oracle10gDBA学习手册中文PDF清晰版最新版本

    **Oracle 10g DBA学习手册:安装Oracle和构建数据库** **目的:** 本章节旨在指导您完成Oracle数据库软件的安装和数据库的创建。您将通过Oracle Universal Installer (OUI)了解软件安装过程,并学习如何利用Database Configuration Assistant (DBCA)创建附加数据库。 **主题概览:** 1. 利用Oracle Universal Installer (OUI)安装软件 2. 利用Database Configuration Assistant (DBCA)创建数据库 **第2章:Oracle软件的安装与数据库构建** **Oracle Universal Installer (OUI)的运用:** Oracle Universal Installer (OUI)是一个图形用户界面(GUI)工具,它允许您查看、安装和卸载机器上的Oracle软件。通过OUI,您可以轻松地管理Oracle软件的安装和维护。 **安装步骤:** 以下是使用OUI安装Oracle软件并创建数据库的具体步骤:

    消防验收过程服务--现场记录表.doc

    消防验收过程服务--现场记录表.doc

    (4655036)数据库 管理与应用 期末考试题 数据库试题

    数据库管理\09-10年第1学期数据库期末考试试卷A(改卷参考).doc。内容来源于网络分享,如有侵权请联系我删除。另外如果没有积分的同学需要下载,请私信我。

    YOLO算法-瓶纸盒合并数据集-3161张图像带标签-纸张-纸箱-瓶子.zip

    YOLO系列算法目标检测数据集,包含标签,可以直接训练模型和验证测试,数据集已经划分好,包含数据集配置文件data.yaml,适用yolov5,yolov8,yolov9,yolov7,yolov10,yolo11算法; 包含两种标签格:yolo格式(txt文件)和voc格式(xml文件),分别保存在两个文件夹中,文件名末尾是部分类别名称; yolo格式:<class> <x_center> <y_center> <width> <height>, 其中: <class> 是目标的类别索引(从0开始)。 <x_center> 和 <y_center> 是目标框中心点的x和y坐标,这些坐标是相对于图像宽度和高度的比例值,范围在0到1之间。 <width> 和 <height> 是目标框的宽度和高度,也是相对于图像宽度和高度的比例值; 【注】可以下拉页面,在资源详情处查看标签具体内容;

    职业暴露后的处理流程.docx

    职业暴露后的处理流程.docx

    Java Web开发短消息系统

    Java Web开发短消息系统

    java毕设项目之ssm基于java和mysql的多角色学生管理系统+jsp(完整前后端+说明文档+mysql+lw).zip

    项目包含完整前后端源码和数据库文件 环境说明: 开发语言:Java 框架:ssm,mybatis JDK版本:JDK1.8 数据库:mysql 5.7 数据库工具:Navicat11 开发软件:eclipse/idea Maven包:Maven3.3 服务器:tomcat7

    批量导出多项目核心目录工具

    这是一款可以配置过滤目录及过滤的文件后缀的工具,并且支持多个项目同时输出导出,并过滤指定不需要导出的目录及文件后缀。 导出后将会保留原有的路径,并在新的文件夹中体现。

    【图像压缩】基于matlab GUI DCT图像压缩(含MAX MED MIN NONE)【含Matlab源码 9946期】.zip

    Matlab领域上传的视频均有对应的完整代码,皆可运行,亲测可用,适合小白; 1、代码压缩包内容 主函数:main.m; 调用函数:其他m文件;无需运行 运行结果效果图; 2、代码运行版本 Matlab 2019b;若运行有误,根据提示修改;若不会,私信博主; 3、运行操作步骤 步骤一:将所有文件放到Matlab的当前文件夹中; 步骤二:双击打开main.m文件; 步骤三:点击运行,等程序运行完得到结果; 4、仿真咨询 如需其他服务,可私信博主; 4.1 博客或资源的完整代码提供 4.2 期刊或参考文献复现 4.3 Matlab程序定制 4.4 科研合作

    YOLO算法-挖掘机与火焰数据集-7735张图像带标签-挖掘机.zip

    YOLO算法-挖掘机与火焰数据集-7735张图像带标签-挖掘机.zip

    操作系统实验 Ucore lab5

    操作系统实验 Ucore lab5

    IMG_5950.jpg

    IMG_5950.jpg

    竞选报价评分表.docx

    竞选报价评分表.docx

    java系统,mysql、springboot等框架

    java系统,mysql、springboot等框架

    zigbee CC2530网关+4节点无线通讯实现温湿度、光敏、LED、继电器等传感节点数据的采集上传,网关通过ESP8266上传远程服务器及下发控制.zip

    1、嵌入式物联网单片机项目开发例程,简单、方便、好用,节省开发时间。 2、代码使用IAR软件开发,当前在CC2530上运行,如果是其他型号芯片,请自行移植。 3、软件下载时,请注意接上硬件,并确认烧录器连接正常。 4、有偿指导v:wulianjishu666; 5、如果接入其他传感器,请查看账号发布的其他资料。 6、单片机与模块的接线,在代码当中均有定义,请自行对照。 7、若硬件有差异,请根据自身情况调整代码,程序仅供参考学习。 8、代码有注释说明,请耐心阅读。 9、例程具有一定专业性,非专业人士请谨慎操作。

    YOLO算法-快递衣物数据集-496张图像带标签.zip

    YOLO系列算法目标检测数据集,包含标签,可以直接训练模型和验证测试,数据集已经划分好,包含数据集配置文件data.yaml,适用yolov5,yolov8,yolov9,yolov7,yolov10,yolo11算法; 包含两种标签格:yolo格式(txt文件)和voc格式(xml文件),分别保存在两个文件夹中,文件名末尾是部分类别名称; yolo格式:<class> <x_center> <y_center> <width> <height>, 其中: <class> 是目标的类别索引(从0开始)。 <x_center> 和 <y_center> 是目标框中心点的x和y坐标,这些坐标是相对于图像宽度和高度的比例值,范围在0到1之间。 <width> 和 <height> 是目标框的宽度和高度,也是相对于图像宽度和高度的比例值; 【注】可以下拉页面,在资源详情处查看标签具体内容;

    搜索引擎lucen的相关介绍 从事搜索行业程序研发、人工智能、存储等技术人员和企业

    内容概要:本文详细讲解了搜索引擎的基础原理,特别是索引机制、优化 like 前缀模糊查询的方法、建立索引的标准以及针对中文的分词处理。文章进一步深入探讨了Lucene,包括它的使用场景、特性、框架结构、Maven引入方法,尤其是Analyzer及其TokenStream的实现细节,以及自定义Analyzer的具体步骤和示例代码。 适合人群:数据库管理员、后端开发者以及希望深入了解搜索引擎底层实现的技术人员。 使用场景及目标:适用于那些需要优化数据库查询性能、实施或改进搜索引擎技术的场景。主要目标在于提高数据库的访问效率,实现高效的数据检索。 阅读建议:由于文章涉及大量的技术术语和实现细节,建议在阅读过程中对照实际开发项目,结合示例代码进行实践操作,有助于更好地理解和吸收知识点。

Global site tag (gtag.js) - Google Analytics