项目管理/互联网/软件全套文档、产品文档、技术文档、测试文档、运维文档、项目文档

前言

       简约文档可提高团队沟通效率;详细文档体系可形成无形价值资产,比如降低人员培养周期。      

       所有文档列表都是基于实际产品、项目情况而定,最好在决定做一个新产品,或实施一个项目时,就根据实际情况拉出一张需要输出的文档列表

产品管理文档列表

       市场调研文档:1、行业分析,包括市场规模、常见盈利模式、增长态势等;2、同行业分析,包括行业细分赛道,比如如在线旅游可以划分成酒店模式、团线电商模式、自助游分享模式等来分析成长空间以及市场成熟度;3、主流产品分析,包括有代表性的产品及公司的硬性指标、增长态势、核心优劣势、各产品间的关系分析等4、新机会分析,包括细分赛道,比如唯品会;5、风险分析,包括产品核心价值的实现,是否依托于一些技术突破、上下游公司以及网络巨头是否容易切入这个领域、是否具有盈利的想象空间。

       用户/客户画像:用户年龄分布、地域分布、特征表现、消费习惯等;B端或KA项目会涉及客户画像,客户公司背景、客户行业、调研部门、部门主管人等。

       商业论证文档:包括关于成本、效益、选项、问题、风险和潜在问题的信息中得到可行性分析结果。商业论证是一种决策支持和规划工具以计划商业行为可能的后果,这些后果可能主要从质量和数量纬度考虑。

       产品逻辑架构图:表达产品设计机制的一张概念图,将可视化的具象产品功能,抽象成信息化、模块化、层次清晰的架构,并通过不同分层的交互关系、功能模块的组合、数据和信息的流转,来传递产品的业务流程、商业模式和设计思路。

       产品结构图(脑图):说明功能包含哪些信息,细化了功能模块以支持开发。

       产品需求分析说明书:是将商业需求文档(BRD)和市场需求文档(MRD)用更加专业的语言进行描述,介绍用户使用产品的逻辑流程,概括性的描述产品需求、产品版本规划、产品整体的框架结构以及功能列表。产品整体流程与产品框架都需要使用相应的图表展现。即是对某个市场或者是客户群来讲的,类似于调研报告,重点是体现出产品要满足哪些功能,哪些是重点、热点。

       产品低/高保真:基本接近产品最终效果图,也可以是Axure画出来的原型。

       UI设计稿:产品最终效果图。

       产品介绍PPT:方面一:1、产品背景。2、产品简介。3、产品功能和产品细节。4、产品特点和作用。5、产品前景和竞争力;方面二:1、客户的需求点是什么。2、客户的痛点是什么。3、放大产品的卖点。4、客观的提出产品的缺点而不是回避。5、从客户的角度去解释产品。6、观点和想法从客户角度出发。7、形式上的创新;方面三:1、介绍公司 的基本情况。 2、产品研发的团队。 3、产品的技术含量。 4、产品的特性。 5、产品的使用范围和效果。 6、产品的持续发展性。 7、后期维护与展望;

       产品需求规格说明书:是从业务规则讲起的,细一点偏向于软件的概要设计。是从开发、测试的角度去讲产品功能,里面要包含原型界面、业务接口、活动图等。

       产品验收文档:列出证明产品验收成果,确保需求符合期望。

       产品主流程图:说明产品主流程的操作与运行过程。

       产品核心数据流转图:说明核心数据的流转过程,如何形成闭环的。

       产品标准功能清单:产品使用的角度来说明产品所拥有的模块、功能,并对每一个功能点进行描述。

       产品定制化功能清单:产品使用的角度来说明产品所拥有的模块、功能,并对每一个功能点进行描述。

       用户操作手册:详细描述软件的功能、性能和用户界面,使用户了解到如何使用该的说明书。

       产品操作培训视频:详细走产品主流程,体现产品价值核心点,并且讲解软件的功能、用户界面设计与理念,使用户根据视频就可达到产品在业务场景下的使用成果。

       产品满意度调查:客户认为产品已达到或超过预期的一种感受,可从多方面进行,比如UI设计、操作体验等。

      数据字典:对数据的数据项、数据结构、数据流、数据存储、处理逻辑等进行定义和描述,其目的是对数据流程图中的各个元素做出详细的说明,使用数据字典为简单的建模项目。

技术管理文档列表

       软件需求规格设计说明书:为了协调各方(客户、架构师、开发、测试等)统一目标的标准文档,因为一旦项目比较庞大,跨越多组织多部门时,这个文档可以省去去很多沟通上的众多麻烦,内容包括目标、用户特点、假定和约束、需求规定、用户场景、运行环境规定、验收标准等。

       系统概要设计说明书:系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、安全设计、数据结构设计和出错处理设计等。

       系统详细设计说明书:每一个软件系统各个层次中的每一个程序 (每个模块或子程序)的设计考虑。

       系统架构图:系统层次、层级,整体性描述。

       系统接口设计文档:接口调用与签名、验证说明等。

       数据库设计文档:数据库设计原则说明,数据库表说明,表与功能模块关系说明等。

       系统开发手册:按照每个功能模块进行分类,对每个功能点的开发源码进行说明。

       主机漏洞安全报告:项目中使用的组件、框架等漏洞的扫描,如阿里云、腾讯云都有提供此类服务。

       基线安全报告:服务器容器级别的检查,如阿里云、腾讯云都有提供此类服务。

       代码扫描报告:代码缺陷、代码漏洞的扫描,如使用Sonar。

       安全漏洞检查报告:运用的框架、组件版本与漏洞进行扫描,如使用腾讯云镜。

       安全白皮书:安全设计框架与原则,安全具体细节实现说明,如在对接时,验证与安全是如何完成,如这个抽奖的过程中,用户的信息安全怎么保护,网络传输过程中怎么保护,前后端对于这个安全的加密是怎么加解密,用了什么算法?整体系统上安全架构这一块是怎么设计的?安全设计架构图是怎么样的?安全框架用了什么框架,在什么地方用到?

       技术选型说明文档:框架/组件选择及搭配说明,以及技术安全性描述。

       数据清理文档:针对测试数据清理,避免在交付时,存在脏数据,包括数据关联图,数据流向图,初始化数据脚本、清理数据脚本,通常先执行清理数据脚本,在执行初始化数据脚本,进而达到系统净化交付。增量更新的测试数据,会根据数据关联图和数据流向图进行清理,比如用户操作记录与审批数据关联,删除审批数据时,也要同步删除用户操作记录数据。

       系统源码:系统全套源码,一般取决商业合作模式而视是否提供源码。

       源码结构说明视频:分层划分的维度,比如微服务是按照业务模块维度做划分的,主流程在源码的跳转关键逻辑,以及相关组件参数配置等。

       源码二次开发说明视频:基于源码结构说明视频讲解架构设计的灵活性,在开发新需求时,如何与原有的设计模式匹配上,进而达到二开成果。

       系统架构说明视频:系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、安全设计、数据结构设计和出错处理设计等。

       维护修改建议说明产品投入运行后,发现了需要进行修正、更改等问题,将存在的问题、修改的考虑以及修改的影响估计作详细的描述。

       安全规范说明:安全管理、安全策略、安全等级等说明。

       开发规范说明数据库开发、代码开发等规范性说明。

测试管理文档列表

       可测试需求说明书:测试需求分析阶段主要工作是获得测试项目的测试需求。

       产品或版本总体测试方案:以测试需求为基础,制定方案。

       产品总体测试策略:以测试需求为基础,分析产品的总体测试策略。

       自动化测试方案:以自动化测试需求为基础,制定方案。

       测试用例(对客端):完成各个特性的测试用例的编写和自动化脚本的编写。

       测试用例(内部端):完成各个特性的测试用例的编写和自动化脚本的编写。

       测试计划:参考估算未来客户私有化测试时间

       手动SIT集成测试报告:手动的测试用例的可度量的执行报告。

       自动SIT集成测试报告:自动化测试用例的可度量的执行报告。

       手动UAT测试报告:手动的测试用例的可度量的执行报告。

       自动UAT测试报告:自动化测试用例的可度量的执行报告。

       渗透测试报告:网络防御按照预期计划正常运行而提供的一种机制。

       压力测试报告:系统可承载压力与单个功能点可承载压力。

       测试验收报告:确保功能测试结果、逻辑测试结果都符合需求期望,并且已知BUG已解决。

       上线业务验证方案:明确上线状态及验证流程,模板可应用将来的增量发布。

       测试度量分析报告:各个阶段的执行情况的可度量的数据分析报告。

       测试关闭报告:数据和项目总结报告。

运维管理文档列表

       资源需求清单:服务器要求、域名数量等配置与数量。

       网络策略说明:需要开通不同安全组之间的网络端口,流量流向权限等。

       环境安全策略说明:用户组权限、目录权限、数据库权限等说明。
       网络架构图(拓扑图):部署结构、数据输入与输出概要呈现。

       系统部署方案设计说明书: 系统架构、产品架构和部署架构的说明,以及对网络拓扑图分层进行分析,以及对部署方案和策略的说明。

       投产上线方案:技术侧的投产流程,业务侧的配合事项进行说明,以及对上线步骤进行剖析,特别是在有关联系统的情况下,模板可应用将来的增量发布。

       上线风险评估及应急回退方案: 对上线风险进行评估,说明可能产生的故障以及触发条件,并提出对应回退方案,模板可应用将来的增量发布。

       安装部署以及启动说明书: 服务器初始化步骤说明,提供对应的安装包清单,说明基础软件安装部署,以及对应服务安装部署,并说明验证方式与投产回退。

       部署安装包:包括组件安装包、相关运行与配置脚本的源文件。

       部署脚本:组件部署脚本说明、应用部署脚本说明,常见文件排查等。

       系统访问媒介安装包:系统是通过浏览器访问的,需要提供浏览器对应版本的安装包,并且说明版本范围,比如谷歌xx版本。

       系统访问配置文档:对于系统是否有特殊的配置要求,比如关闭防火墙等操作。

       系统运维手册:说明系统结构与网络拓扑图,对于服务器信息及域名、数据库、中间件等进行说明,业务流程的设计,应用等同样要进行对应的说明。

       运维操作手册:应用管理的启停依赖等说明,并补充对应的定时任务失败等情况如何处理,对于服务器的告警、巡检等内容进行补充。

       应急响应及恢复预案:系统运行资源、指标、IP和端口,软硬件等基础进行说明,并说明系统应急场景分类、前置条件、处理方式等。

       双活及灾备方案:架构说明,应用服务器清单说明,容灾方案、测试方案说明。

       一键启动脚本说明:服务启动脚本及执行说明。

       一键部署脚本说明:服务自动化部署脚本及执行说明。

       监控工具说明书:系统监控、应用监控、定时任务监控等。

       运行指标文档:系统支撑的指标数据,比如QPS;对于指标分层,比如CPU超过80%是非监控状况,正常的范围值是多少。

项目管理文档列表

       项目可行性研究:确定项目是否可行或选择最佳实施方案的工作,内容包括项目基本情况、项目背景、可能的项目方案、初步评估意见等。

       项目描述:综合性地简要介绍项目的基本情况,包括项目基本情况、项目目的、项目的关键成功要素、项目影响范围、项目主要里程碑计划、项目假设、项目约束条件、项目评价标准、项目主要利益相关方等。

       项目章程(最好有公司内部确立执行此项目,授权团队成员权利,内容包括项目基本情况、项目目的、项目目标、项目范围、项目利益相关方的角色与责任、有关项目的权限、管理检查点、相关方签字等。

       项目启动会PPT:项目目标、项目范围、项目组织结构、项目里程碑计划、项目实施计划、项目升级流程、沟通机制、项目前期工作等。

       团队章程(必须有)章程说明与管理规范,包括目标、成功标准、退出标准、内/外部相关方、成员分工与职责、基本沟通流程、需求沟通流程、对内/对外沟通矩阵、微信群管理制度、会议管理制度、需求确认流程、技术确认流程、升级流程、冲突/风险/问题处理流程等。

       项目范围管理:相当于SOW,对项目所要完成的工作范围进行综合描述,包括项目基本情况、项目成果/完成标准、使用的方法、项目包含内容、项目不包含的内容、相关方确认签字等(客户签字是很重要,影响验收)。

       项目风险管理计划:如何在应对风险与措施,比如风险升级流程,内容包括项目基本情况、风险管理策略、风险分类、风险分析、风险处置、风险处置后分析等。

       风险登记册:风险描述、优先级、责任人、跟进人、状态、影响范围、应对措施等。

       问题登记册:问题描述、优先级、责任人、跟进人、状态、影响范围、处理措施等。

       待办事项列表:待办事项描述、跟进人、执行人、处理措施、状态、要求完成日期等。

       项目配置管理计划:人事物配置策略,内容包括项目基本情况、配置管理职能领域及资源、标准、流程、政策及方针、配置识别、识别方法、控制项的提交与检索、版本控制、项目使用媒体的保存处理及交付、与承包商配置管理的关系、其他信息等。

       项目采购管理计划:制定出能够最好地满足项目需求的采购工作计划安排的管理流程,内容包括项目基本情况、采购定义、合同责任、决策标准、采购合同类型、合同标准等。

       项目资源管理计划:可以看作战场上的排兵布阵,就是确定、分配项目中的角色、职责和回报关系,内容包括项目基本情况、资源概要、项目资源信息、人力资源计划等。

       资源清单:物品资源列表、人员资源列表等。

       项目预算:将真正的成本显示出来,便于成本控制,有利于对各项目活动成果进行评价、考核,内容包括项目基本情况、预算分类等。

       项目质量管理计划:如何确保质量成果产出的过程,内容包括项目基本情况、项目工作范围、可交付成果描述、可交付成果的验收标准、质量保证的各种活动、项目监控、项目质量小组责任等。

       项目沟通管理:与客户如何沟通,升级流程如何等,内容包括项目基本情况、沟通时间、信息类型、现行沟通系统、需要信息的时间长度、考虑的环境因素、更新沟通计划的方法等。

       相关方登记册:内部团队成员姓名、手机号码、职位、经验等;外部相关方,姓名、权利、职位、影响等。

       项目会议纪要:包括基本信息、会议目的、参加人员、发放材料、发言记录、会议决议、会议纪要发放范围等。

       项目变更控制计划:对项目的变更进行有效的控制,从而更好地实现项目的目标,内容包括项目基本情况、请求变更信息、对变更请求的初步审查结果、初步的影响分析、影响分析结果、变更审查人员签字等。

       需求开发计划:消除或减少不确定性,对项目目标有更好的理解,内容包括需求、涉及方(A团队/B团队)、需求负责人、需求状态(评审/确认)、需求文档名称、技术负责人、技术方案状态(评审/确认)、技术方案文档、开发时间、开发状态、测试时间、测试状态、产品验收时间、产品验收状态、客户验收时间、客户验收状态等。

       节假日与重要日期列表:XX会议、国庆节等,都会有护网活动,此时是不能服务器操作与其他限制,计划需要考虑这些节假日与重要日期影响。

       项目阶段评审报告:通常在里程碑结束发出,内容包括项目基本情况、当前活动状态、本周期内的主要事件、下一个汇报周期内的行动计划、财务状况、技术状态和问题、上一次汇报周期中遗留问题的处理、项目风险因素的更新等。

       项目验收报告:验收范围、验收成果、遗留事项等。

       项目总结报告/PPT:整体情况的综合分析,包括项目信息、项目背景与要求、项目总结。

       项目满意度调查:指客户认为项目已达到或超过预期的一种感受,可从多方面进行,比如运行指标、操作流程、UI设计等。

你可能感兴趣的:(企业,团队,项目管理,产品文档,技术文档,测试文档,运维文档,项目管理文档)