web产品的交互说明文档应该怎么写( 四 )


3.3.4 数据管理能力
说明需要管理的文卷和记录的个数、表和文卷的大小规模,要按可预见的增长对数据及其分量的存储要求作估算 。
3.3.5 故障处理
列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求 。
3.4 环境
描述所开发软件运行所需的环境 。
3.4.1 设备环境
描述运行软件系统所需的设备能力,如:
处理器的型号和内存容量 。
存储媒体的数量 。
通信网络(包括说明网络结构,线路速度及通讯协议等) 。
3.4.2 支持软件环境
列出与待开发的软件互相配合的支持软件(包括名称,版本号和文件资料),必要时还应列出测试软件,还要指出该软件用的编程语言,编译程序,操作系统和数据管理系统 。
3.4.3 接口
说明本软件与其他软件之间的接口、数据通信协议等 。
3.4.4其他
说明本软件系统在安全和保密方面的要求以及用户对使用方便、可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求 。
7.如何才能写出好的产品文档一般来说,产品文档分为产品需求文档和产品使用文档两种 。
产品需求文档主要面向的是产品的开发、设计者,期望是产品的实际开发人员了解产品的细节,让开发完成的产品达到前期设计需求的预期;产品使用文档面向的主要是使用者,使其通过产品文档掌握产品的功能使用,也就是我们常说的产品使用帮助;如果不搞清楚文档面向的对象,往往写出来达不到预想的效果 。类似这样专业的文档文案,其实是有一定共通性的;掌握这类文案的写作技巧,尤其对我们IT从业人员来说,是一项非常不错的技能 。
笔者从业这两年,跟此类文档打过不少交道,在这里跟各位分享一些经验 。1、对象要清楚开篇就提到了,清楚文档面向的对象的重要性 。
对于不同的对象,必须使用不同的写作思路来对待,尽可能的站在对方的角度去思考 。他需要看到什么?什么内容对他有用?我如何阐述给他?对于产品设计人员,他所需要了解的是产品的样式、界面、交互等情况,对于实际编码人员,他则偏重于产品的可实现性,你的内容则需要偏注产品的功能细节和内部处理 。
所以,文档面向的对象决定了文档的功能和内容 。确定文档面向的对象才能做到有的放矢 。
2、条理要清晰文档的条理清晰不仅让你的文档看起来比较顺畅,更让阅读者能够很清楚的理解 。所以,下笔之前就应当知道自己的文档内容大致分为哪几个大的模块、模块下又细分了多少个子模块,然后在大纲的基础上,再进行详细的内容填充 。
笔者之前的经验,往往在文档下笔之前认真思考了好几天,总希望在下笔之前就希望把所有的问题都想清楚 。这对于写作者来说,是一件不好的举动 。
其实,东西在脑子里转悠,不如在纸上来的直观 。大纲列出来之后,然后再来反复的添加、修改,比你按笔不动要来的有效率得多 。
对于写作来说,最难的也是开始 。3、逻辑要严谨产品类的文档不同于平常我们书写的文档类型 。
对于内容叙述的严谨性要求非常严格 。因为你的文档不单单是一个你对这个项目、产品的理解,它更是需要做为一个协作的载体让其他的同事同时使用,更可能成为其他同事工作方向的指引 。
因此,严谨是必须的 。所以,在满足了文档条理清楚的前提下,仔细斟酌、思考文档可能会出现歧义、漏缺的部分,反复修改文档成为了一项必须的工作 。
在大家协调工作的背景下,你一个人不可能将所有的问题都考虑清楚 。所以往往出现同事指出你文档中存在的毛病和漏洞 。