软件用户文档写作.ppt

软件用户文档写作,郭小东 2012年4月9日,什么是软件用户文档？,用户文档是软件开发人员为软件用户了解、使用、操作和维护等提供的详细资料。用户文档包括用户手册、操作手册和维护修改建议手册等。,编制用户文档的基本要求,用户文档的完整程度描述与实际功能的一致性用户文档的易理解程度,写好用户手册的重要性,一个优秀的用户手册可以帮助用户快速入门，是用户正确、充分使用软件的前提。对于开发者来说，质量符合要求的用户手册，至少可以减少用户培训和售后服务的投入。,好的用户手册应做到,1、用户手册的完整性2、用户手册的描述与软件实际功能的一致性3、用户手册的易理解性4、用户手册提供学习操作的实例5、用户手册印刷预包装质量,用户手册的内容,用户手册不同于用户使用说明书，它除了向用户提供基本的产品操作方法，还要提供很多与产品相关的其它信息。主要包括以下方面：-介绍：软件的基本情况-用途：介绍软件的适用范围、功能、性能主要及其特点-运行环境：介绍软件最基本的和推荐的运行配置、软件安装说明、参数设定等，以及可能引起的和系统的冲突，解决途径等-使用过程：向用户介绍软件具体的使用方法-相关信息：必要的开发者信息，软件注册、升级途径等,什么是操作手册,操作手册是指导软件具体操作的工具书。操作手册涉及软件设计完成后的以后所关心的有关操作的内容。一般而言操作手册应包括：引言、操作原理、操作说明、注意事项、附录,操作手册与用户手册的区别,1操作手册是用户手册的一部分。2操作手册是系统级别的文档，而用户手册是需求级别的文档3在做项目的时候操作手册可以代替用户手册，因为各方面的需求很明确4用户手册不光是对系统操作的说明，而从头开始的服务器配置，系统安装、系统操作系统维护等，完全是成熟的流程模式。,软件维护手册,软件维护手册主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明等，维护手册的软件使用部分，还应介绍系统功能、性能及操作在维护后的变化。,