3 软件文档编制要求
软件文档编制的原则
应该适应文档的读者
应有必要的重复性
应具有一定的灵活性
应覆盖整个软件的生存周期
应是可管理的
应采用并标明文档标准
应规定支持的工具
软件文档编制的灵活性
文档的种类
文档的详细程度
文档的扩展
章节的扩展与缩并
程序设计的表现形式
文档的表现形式
文档的其他种类
软件文档标准的建立步骤
选择软件生存周期模型
规定文档类型和内容
确定文档的质量等级
最低限度文档（一级文档）：个人开发自用
内部文档（2级文档）：团队内部交流
工作文档（3级文档）：项目开发
正式文档（4级文档）：产品开发
软件文档编制的步骤
制定文档编制计划
编写文档
文档编号
文档评审
文档部署
文档的归档与保存
文档维护
软件文档的质量要求
针对性
精确性
清晰性
完整性
灵活性
可追溯性
软件文档的编制技巧
- 从技术角度进行文档的编制和评价
- 明确文档编制人员的责任
- 让编制人员对开发项目有准确的认识
- 让开发和设计人员参与文档审阅工作
项目开发文档化
- 记录项目中的各种数据
- 总结项目开发经验
- 规范团队开发过程
- 增强项目可见度
- 提高团队沟通效率
本博客所有文章除特别声明外，均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来源 Estom的博客！
相关推荐
2023-10-21
01 基本概念
1 概述简介Prometheus 就是一个时序数据库，每隔一段时间收集一次数据，连起来就是一段时间的监控数据。 一种多维数据模型，其中包含通过 metric 名称和键/值对标识的时间序列数据 可利用各种维度的灵活的查询语句 PromQL 不依赖分布式存储；单服务节点是自治的 时间序列通过 HTTP 拉取方式进行收集 支持通过中间网关推送时间序列 通过服务发现或静态配置发现目标 多种图形和仪表板支持模式 架构 Prometheus 服务器Prometheus Server 是 Prometheus组件中的核心部分，负责实现对监控数据的获取，存储以及查询。 NodeExporter 业务数据源业务数据源通过 Pull/Push 两种方式推送数据到 Prometheus Server。 AlertManager 报警管理器Prometheus 通过配置报警规则，如果符合报警规则，那么就将报警推送到 AlertManager，由其进行报警处理。 可视化监控界面Prometheus 收集到数据之后，由 WebUI 界面进行可视化图标展示。目前我们可以通过自...
2021-12-24
blkid
blkid查看块设备的文件系统类型、LABEL、UUID等信息 补充说明在Linux下可以使用 blkid命令 对查询设备上所采用文件系统类型进行查询。blkid主要用来对系统的块设备（包括交换分区）所使用的文件系统类型、LABEL、UUID等信息进行查询。要使用这个命令必须安装e2fsprogs软件包。 语法1234blkid -L | -Ublkid [-c ] [-ghlLv] [-o] [-s ][-t ] -[w ] [ ...]blkid -p [-s ] [-O ] [-S ][-o] ...blkid -i [-s ] [-o] ... 选项123456789101112131415161718192021-c <file> # 指定cache文件(default: /etc/blkid.tab, /dev/null = none)-d # don't encode non-printing characters-h # 显示帮助信息-g # garbage collect the ...
2022-10-09
01 3IOC基于注解容器管理
IOCBean管理基于注解方式基于注解方式IOCBean管理1 简介注解概念 注解是代码特殊标记，格式:@注解名称(属性名称=属性值，属性名称=属性值) 注解的位置：注解可以作用在类、属性、方法。 使用目的：简化XML配置 IOC的两个步骤 创建对象 注入属性 2 基于注解方式创建对象实现创建对象的注解四个注解功能是一样的，都可以用来创建bean实例。 @Component 组件层 @Service service层 @Controller web层 @Repository DO层 使用注解创建对象bean的步骤 引入依赖。spring-aop（该jar包实现了注解） 开启组件扫描(context命名空间，添加扫描) 检测到组件扫描，会扫描包下的所有类。 可以通过filters过滤 12345678910111213<?xml version="1.0" encoding="UTF-8"?><beans xmlns="http://www.springframework.org/...
2021-06-15
3 TLS协议变迁
1 TSL1.0概念 TLS(Transport Layer Security，传输层安全协议)，用于两个应用程序之间提供保密性和数据完整性。 TLS 1.0是IETF（Internet Engineering Task Force，Internet工程任务组）制定的一种新的协议，它建立在SSL 3.0协议规范之上，是SSL 3.0的后续版本，可以理解为SSL 3.1(可简单理解为同一事物不同阶段的不同称呼)，它是写入了 RFC 的。该协议由两层组成： TLS 记录协议（TLS Record）和 TLS 握手协议（TLS Handshake）。较低的层为 TLS 记录协议，位于某个可靠的传输协议（例如 TCP）上面。 特点 对话的内容用”对称加密”,而对于”对称加密”带来的密钥传输问题,则由”非对称加密”来解决,由于客户端没有”非对称加密”的解密能力,所以密钥由客户端来产生并用公钥加密传输给服务端,这样就(在思路上)解决了密钥传输的安全问题和对话数据解密的性能问题 技术2 TSL1.1特点 隐式初始化向量（IV）被显式IV替换以防止CBC攻击[CBCATT]。 填充错误的处...
2020-09-27
6.支持向量机
第6章 支持向量机1 支持向量机 概述支持向量机(Support Vector Machines, SVM): 是一种监督学习算法。 支持向量(Support Vector)就是离分隔超平面最近的那些点。 机(Machine)就是表示一种算法，而不是表示机器。 2 支持向量机 场景 要给左右两边的点进行分类 明显发现: 选择D会比B、C分隔的效果要好很多。 3 支持向量机 原理SVM 工作原理 对于上述的苹果和香蕉，我们想象为2种水果类型的炸弹。（保证距离最近的炸弹，距离它们最远） 寻找最大分类间距 转而通过拉格朗日函数求优化的问题 数据可以通过画一条直线就可以将它们完全分开，这组数据叫线性可分(linearly separable)数据，而这条分隔直线称为分隔超平面(separating hyperplane)。 如果数据集上升到1024维呢？那么需要1023维来分隔数据集，也就说需要N-1维的对象来分隔，这个对象叫做超平面(hyperlane)，也就是分类的决策边界。 寻找最大间隔 点到超平面的距离 分隔超平面函数间距:$$y(x)=w^Tx+...
2021-12-24
hping3
hping3测试网络及主机的安全 补充说明hping 是用于生成和解析TCPIP协议数据包的开源工具。创作者是Salvatore Sanfilippo。目前最新版是hping3，支持使用tcl脚本自动化地调用其API。hping是安全审计、防火墙测试等工作的标配工具。hping优势在于能够定制数据包的各个部分，因此用户可以灵活对目标机进行细致地探测。 安装12345678yum install libpcap-devel tc-develln -s /usr/include/pcap-bpf.h /usr/include/net/bpf.hwget http://www.hping.org/hping3-20051105.tar.gztar zxvf hping3-20051105.tar.gzcd hping3-20051105./configuremakemake install 选项1234567891011121314151617181920212223242526272829303132333435363738394041424344-H --help 显示帮助。-v...
