项目开发过程文档

2023-10-29

1.项目开发计划

项目开发计划内容覆盖项目整个开发周期内的人员调度,所属阶段(需求、设计、编码、测试、实施)、模块划分,开始和结束时间(计划、实际)。

2.需求规格说明书

需求规格说明书是对客户需求的理解形成的文档,为了确定与客户需求一致,在此基础上开展项目的后续工作。

3.概要设计说明书

概要设计说明书应从项目的架构(技术选型、系统架构)、总体设计(功能结构、数据结构、展现设计)和功能设计方面作简要描述,以及其他的一些非功能设计。

4.详细设计说明书

细化到项目的每个模块,每个功能的说明文档。

5.数据库设计说明书

数据库的表的详细信息(字段,类型,长度,解释)。

6.接口说明书

接口说明书一般主要阐述所有service层的方法及使用(功能描述,参数说明,返回类型),有的还包括实现过程、所涉及的sql脚本和错误处理。

7.系统部署文档

一般由研发人员提供项目包、系统部署文档和所需软件给现场,交由现场运维人员进行部署与维护,如果是较为复杂的项目,一份逻辑清晰,言简意赅的部署文档就显得尤为重要,部署文档一般包括所有部署项目中的操作步骤:

  1. 环境要求(tomcat、jdk版本、数据库、服务器、redis等等);
  2. 准备工作(数据库初始化、项目包配置文件修改);
  3. 正式启动(若包含多个包,有顺序要求的也应标注出来)。

如果有需要修改的部分,建议使用文字描述和截图的方式解释清楚;如果需要在linux执行某些命令,建议将这些命令也编辑在文档中,方便运维人员直接复制。

8.用户操作手册

用户操作手册应清楚的描述每一个功能的使用,及页面出现的所有输入框、状态、按钮的解释。

9.系统管理员手册

系统管理员手册是为了现场交付日常维护时,处理某些问题时可以参考的文档。一般项目都有供交付人员使用的后台系统,手册中应清晰的描述后台每一个功能的使用及其常见问题的解决方案。

 

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

项目开发过程文档 的相关文章

  • innodb_lock_wait_timeout 参数

    innodb lock wait timeout 参数 innodb lock wait timeout 参数指定了 InnoDB 引擎在等待行级锁或间隙锁的最长时间 以秒为单位 如果一个事务在超过该时间后仍然无法获取锁 那么该事务就会被取
  • upload-labs靶场 11-19关 详细教学 上传漏洞

    第11关 这关采用的防御手法是白名单过滤 只允许上传jpg png和gif类型 并且将上传的文件给重命名为了白名单中的后缀 这里我们用00截断 要求是php版本低于或等于5 3 4 这一关上传目录是可控的 所以可以先上传一个后缀名为 jpg
  • Vue-admin-template结合后端配置动态路由+动态侧边栏

    Vue admin template结合后端配置动态路由 动态菜单 在使用这个vue admin template的时候 发现其官方文档的推荐是使用动静结合的方法去配置动态路由 其官方大致过程就是 此处路由数组为通用跳转路径 意思是不需要权
  • C# 多线程笔记

    多线程 启动线程方式 new Thread Start 启动线程 Task Factory StartNew 启动线程 线程池启动TreadPool QueueUserWorkItem 启动工作线程 BackgroundWorker Run
  • 一款不错的基于WEB技术的文件服务器

    首先 让我感谢朋友ZHANGBIN给介绍的这个程序 一个不错的 只有500KB左右且免安装的小程序 说明 这是一款不错的基于WEB技术的文件服务器 能够使用它进行文件的上传和下载 呵呵 如果是进行一些小文件的INTERNET传输 或是较大文
  • 华为云计算之华为私有云初识

    华为云计算之华为私有云初识 一 huawei cloud stack私有云解决方案 二 华为云Stack功能介绍 三 华为FusionCloud典型部署 四 FusionCloud部署场景 五 双核心组网 Spine BL和SL合并拓扑图
  • MNE-Python工具箱使用raw.plot绘图时遇到问题

    使用MNE Python工具箱进行脑电数据分析时绘图的代码如下所示 import matplotlib import pathlib import mne matplotlib use Qt5Agg 加载原始数据及其路径 raw path
  • github里的默认域_渗透基础——域用户的密码永不过期属性

    0x00 前言 在域环境中 域用户的凭据是十分重要的信息 为了增强安全性 域组策略会设置所有域用户口令的最长有效时间 到达过期时间后强制用户更改口令 在实际环境中 有些域用户需要设置为密码永不过期 这可以通过添加密码永不过期属性来实现 在域
  • Linux系统中Qt程序指定位置加载库文件的四种方式

    这边提供四种方法 方法一 环境变量临时加载 export LD LIBRARY PATH home yjd code mylib 这种方式在终端退出后就会失效 方法二 配置环境变量到当前用户的 profile文件中 在 profile文件末
  • python 爬虫(一) requests+BeautifulSoup 爬取简单网页图片代码示例

    最近学习了Python 借助各个大神的文章 自己写了以下代码 来爬取网页图片 希望可以帮助到大家 工具是 idea coding utf 8 import requests from bs4 import BeautifulSoup imp
  • Linux虚拟机安装及其注意事项!

    Linux虚拟机安装及其注意事项 安装须知 装前必看 一 安装虚拟机 二 安装操作系统 总结 安装须知 装前必看 本次安装为运用VMware workstation虚拟机软件在物理机上进行安装 本次安装为RedHat Enterprise
  • Swift5.0 WKWebView中的JS交互

    好的团队离不开大家的默契合作 在开发中经常遇到H5和移动端合作的业务 在开发中JS交互是非常常见的 小萌现在的主打语言是Swift 所以封装一下Swift版的JS交互 完整代码 在此之前加入协议WKNavigationDelegate WK
  • C# winform流程图(功能超完整附下载链接)

    C winform流程图 功能超完整 工具箱 文件存储打开 画布放大缩小 图元操作 操作步骤 可撤销 图元属性调节 点我下载项目源码 1 工具箱创建图元 矩形 菱形 圆 直线 曲线 其他图形可以自行仿照开发 2 图元有六个操纵柄 四个连接点
  • vs2008编译live555源码

    1解决方案编译方式 1 1简介 Live555 是一个为流媒体提供解决方案的跨平台的C 开源项目 它实现了对标准流媒体传输协议如RTP RTCP RTSP SIP等的支持 Live555实现了对多种音视频编码格式的音视频数据的流化 接收和处
  • cudnn配置

    2019独角兽企业重金招聘Python工程师标准 gt gt gt cudnn cuda config sudo cp cuda include cudnn h usr local cuda include sudo cp cuda lib
  • L2-029 特立独行的幸福

    对一个十进制数的各位数字做一次平方和 称作一次迭代 如果一个十进制数能通过若干次迭代得到 1 就称该数为幸福数 1 是一个幸福数 此外 例如 19 经过 1 次迭代得到 82 2 次迭代后得到 68 3 次迭代后得到 100 最后得到 1
  • 使用python实现自动点击功能

    猜你感兴趣 使用Pyqt5玩转ChatGpt 内网文件共享服务 快速搭建私有pip镜像源 python设计模式 创建型模式 docker搭建私有git服务器 项目备份和迁移 redis持久化方案 被测点击界面 新建counter html添
  • CDH简介及CDH部署、原理和使用介绍( 版本6.3.1 )

    CDH简介及CDH部署 原理和使用介绍 版本6 3 1 第一章 CDH简介 CDH概念 CDH是Cloudera的100 开源平台发行版 包括Apache Hadoop 专为满足企业需求而构建 CDH提供开箱即用的企业使用所需的一切 通过将
  • python 模型 ORM简介

    Django之ORM Object Relational Mapping ORM 一 ORM介绍1 ORM概念 对象关系映射模式是一种为了解决面向对象与关系数据库存在的互不匹配的现象的技术 2 ORM由来 让我们从O R开始 字母O起源于
  • 菜狗杯Misc你会异或吗wp

    题目给出提示 神秘数字0x50 下载附件后是一个打不开的png 用010打开看下内容 结合异或和0x50的提示 可以发现0xD9 0x50 0x89 0x00 0x50 0x50 0x1E 0x50 0x4E 所以很明显了文件开头应该恢复成

随机推荐

  • 【AI实战】开源可商用的中英文大语言模型baichuan-7B,从零开始搭建

    AI实战 开源可商用的中英文大语言模型baichuan 7B 从零开始搭建 baichuan 7B 简介 baichuan 7B 中文评测 baichuan 7B 搭建 参考 baichuan 7B 简介 baichuan 7B 是由百川智
  • Linux动态库(一)之同名符号

    万事皆有缘由 还是先从我遇到的这个问题说起 问 有一个主执行程序main 其中实现了函数foo 同时调用动态库liba so中的函数bar 而动态库liba so中也实现了foo 函数 那么在执行的时候如果在bar 中调用foo 会调用到哪
  • TypeScript(单独运行ts、webpack运行ts)

    TypeScript是一门编程语言 完全兼容JavaScript 是JavaScript的超集 引入类型系统 可以尽早的定位错误位置 提升开发效率 全局安装typescript环境 npm i g typescript 检查是否安装成功以及
  • 如何解决netty自定义协议粘包分包问题

    又一次发现公司同事用netty竟然都不处理粘包分包的问题 出了问题都不知道怎么回事 呵呵哒 sp厂商反馈数据已推送至我方提供的地址 但未收到我方的应答 正常推送了一次 又重试三次 都没有收到我方应答 看了下代码 又跟踪了几条日志 发现sp数
  • 【09】MySQL:MHA + Atlas 实现读写分离高可用

    写在前面的话 前面做了 MHA 高可用 但是存在这样一个问题 我们花了 4 台机器 但是最终被利用起来的也就一台 主库 这样硬件利用率才 25 这意味着除非发生故障 不然其他几台机器都是摆设 明显的资源浪费 那么有没有一种办法把这些机器利用
  • STL--list容器(链表)

    一 list基本概念 1 功能 将数据进行链式存储 2 链表 链表 是一种物理存储单元上非连续的存储结构 数据元素的逻辑顺序是通过链表中的指针链接实现的 链表的组成 链表是由一系列结点组成 结点的组成 一个是存储数据元素的数据域 另一个是存
  • 距离矢量路由协议举例——RIP

    1 工作原理 RIP 是一种分布式的基于距离矢量的路由选择协议 RIP 协议要求网络中的每一个路由器都要维护从它自己到其他每一个目的网络的距离记录 RIP 协议中的 距离 也称为 跳数 hop count 因为每经过一个路由器 跳数就加 1
  • [转](47条消息) Docker上运行jar包

    一 准备好jar包 准备一个jar包 上传到指定的目录 这里我上传的是 usr local docker 二 编写 Dockerfile FROM命令定义构建镜像的基础镜像 该条必须是dockerfile的首个命令 FROM java 8
  • 关于cstdio和iostream,以及有关namespaces的问题

    1 cstdio是面向 文件 的 或者不强调文件和非文件流的区别 默认流就是可以关联外部文件 至于文件的外延是啥就不管 扔给宿主环境了 从std FILE这个名字以及printf scanf接口描述基于fprintf fscanf上就可以看
  • 100天精通Python(可视化篇)——第84天:matplotlib绘制不同种类炫酷直方图参数说明+代码实战(普通、多变量、堆叠、分组、多个子图、折线、曲线直方图)

    文章目录 专栏导读 1 直方图介绍 1 介绍 2 直方图的五种形态 1 标准型 2 孤岛型 3 双峰型 4 折齿型
  • 是jenkinsfile中可以用java_Jenkins基础:Jenkinsfile使用实例:7:使用集成的工具进行操作...

    文章目录 隐藏 tools 示例 环境准备 全局工具设定 获取Jenkins Crumb 创建Job Jenkinsfile说明 事前准备 执行Job 确认执行结果 总结 参考内容 Jenkins可以与其他工具进行集成 并通过在Global
  • 史上最全面的DateUtils工具类

    此工具类包含了基本上常用的工具类 包含对于各种类型的日期的转换 以及转成我们所需要的各种类型日期格式 public class DateUtils 仅显示年月日 例如 2015 08 11 public static final Strin
  • 广西高等教育学会高校教育技术委员会莅临瑞云科技考察交流

    2023年3月18日上午11点整 广西高等教育学会高校教育技术专业委员会组织了一批来自广西各院校的专家老师 来到深圳市瑞云科技股份有限公司 以下简称瑞云科技 参观考察 瑞云科技是一家专注为视觉行业提供垂直云计算服务的公司 用户超20万 遍及
  • 掌握Python文件操作的绝招:打造数据之径,揭开文件操作的神秘面纱

    文章目录 前言 文件的基本操作 打开文件操作 关闭文件操作 对文件进行操作 1 只读文件操作 read readlines readline seek 2 只写文件操作 3 文件追加操作 读写 追加读写操作 1 r 模式打开文件 2 w 模
  • 代码评审(Code Review)规范

    一 目的 Code Review是一种用来确认方案设计和代码实现的质量保证机制 通过这个机制我们 可以对代码 测试过程和注释进行检查 Code Review主要用来在软件工程过程中改进代码质量 通过Code Review可以达到 如下目的
  • Pycharm以及cmd调用Anaconda已配置环境的方法

    1 Anaconda配置环境 打开Anaconda软件 点击Anvironment Create 编辑环境Name 选择Python版本 一台计算机可以安装多个版本的Python Pycharm可以直接使用Anaconda创建的环境 依次点
  • idea技巧

    Ctrl P 查看方法参数 Ctrl Q 查看类 方法 属性注释 Alt Enter 提示 ctrol shift 上下键 将本行文字上下移动 ctrl o 重写方法 ctrl i implement 方法实现 Ctrl u 或者b 方法详
  • 最受推荐的10本Python书籍

    Python是一种通用的解释型编程 主要用于Web开发 机器学习和复杂数据分析 Python对初学者来说是一种完美的语言 因为它易于学习和理解 随着这种语言的普及 Python程序员的机会也越来越大 如果你想学习Python编程 市场上就有
  • C++ 单例模式

    原创文章 转载请注明出处 目录 C 单例模式介绍 一 单例是什么 二 C 实现单例 2 1 基础要点 2 2 C 实现单例的几种方式 C 单例模式介绍 单例可能是最简单的一种设计模式 实现方法很多种 同时单例也有其局限性 本文对C 单例的常
  • 项目开发过程文档

    1 项目开发计划 项目开发计划内容覆盖项目整个开发周期内的人员调度 所属阶段 需求 设计 编码 测试 实施 模块划分 开始和结束时间 计划 实际 2 需求规格说明书 需求规格说明书是对客户需求的理解形成的文档 为了确定与客户需求一致 在此基