软件工程笔记:文档自动化

软件工程基础学习笔记 博猪是一枚苦逼的搞基网络攻城狮,即将毕业的应届毕业生。 目前自学软件工程、python转型搞基程序猿,感觉好像离进化成人类又进了一步呢~ 不喜勿喷,全靠一身肥膘在支撑。 阅读详情

文档自动化

— 笔记整理自 北京理工大学 计算机学院

文档自动化

  • 文档很重要!
  • 软件开发人员不爱写文档
  • 软件的使用和维护必需文档
  • 多余的文档对客户和开发人员都是一种负担
  • 不爱写文档 -> 没人读 -> 文档过时
  • 文档自动化的优势
  • 简化项目文档生成过程
  • 维持精确性、一致性和时效性
  • 减轻开发人员负担

设计文档

  • 在早期的软件开发过程中,设计和编码是分开的
  • 不同的人员使用不同开发工具,程序员编码时很容易偏离设计
  • 现在很多IDE厂商如:vs 在其中植入了多工种平台,架构师,设计师,程序员可以在同一个IDE中进行工作
  • 从类图到代码,从UML模型到html文档, 再加上版本控制工具,不同工种之间的协作更加流畅了
  • Together的代码和类图实现双向同步功能,让文档的编写和生成不再是痛苦的事情

LiveSource TM 技术

  • 双向同步功能的建模工具是让人兴奋的事情,之间是单项工具,画好类图后进行生成,比较鸡肋。
  • Together的LiveSource TM 技术实现了时时双向同步技术

代码逆向UML图

  • 设计阶段的UML图与代码不一致
  • 构建时自动生成UML图
  • 从本质上来说UML本身也是一种非常重要的文档
  • 示例:UMLGraph工具
    • UMLGraph和javadoc生成了html格式的UML类图
    • 具体做法是:在注解脚本中把代码中想提取的一些javadoc注释的属性传入,生成和代码一致的UML类图
    • 这些操作可以封装在脚本里, 自动的跑起来,每次构建都会得到最新的文档并自动发布到开发团队的内部网站上去

数据库文档化

  • 绝大多数软件系统都采用数据库来存储数据
  • 数据库的设计和管理需要采用很专业的技能
  • 数据库设计工具ERWin正向设计流程
    • 设计好ER图
    • 通过ERWin等工具画出逻辑视图和物理视图
    • 确定实体之间的关系
    • 确定主键、外键、字段属性等等
    • 这些工具可直接连接数据库
    • 将物理视图转化为DBL代码, 并在数据库中执行
    • 同时可导出各类数据词典文件, 作为数据库设计的文档
    • 这些操作很方便,也很强大
    • 这里依然存在文档生成的方向性问题
    • 程序员在编程过程中需要修改数据库的某个表,字段,如何维持一致性
    • 手工维护工作量巨大,不能保证完全的一致性

数据库文档化示例

  • 从数据库中抽取所需的元素生成数据库文档
  • 这个方案是众多方案中的一个,比较灵活
  • 结合SchemaSpy, Ant 和 javadoc 最后生成了html格式的数据库文档
  • 配置焦恩可以配置到持续集成的过程中,每次编译后是最新的


备注:图片托管于github,请确保网络的可访问性

代码文档化示例

  • 代码的局部说明
    • 行注释//…
    • 块注释/…/
    • Javadoc注释 /** …*/
    • Xml注释 ///
  • API文档可以更全面了解代码
  • 通过Javadoc,Ndoc, Doxgen等文档工具可以将注释和相关代码提取出来,进一步处理为易于阅读的外部文档htm,doc,pdf等

用户文档示例

  • 最头疼的是用户文档,大部分时间都浪费在文档的复制粘贴上,对文档的排版更是麻烦
  • 结合使用 Ant、一个 DocBook XSL 文件和 XSL Formatting Objects (XSL-FO) 来生成 PDF 格式的用户文档


备注:图片托管于github,请确保网络的可访问性
《软件工程》学习笔记 软件工程是技术与管理的结合,需掌握方法学、过程模型、质量控制与团队协作。通过理论学习与项目实践(如开发一个全流程项目),可深化对核心概念的理解。 阅读详情

相关推荐

软件工程学习笔记14——案例解析篇

复盘也是整个项目开发过程中很重要的一部分,正是因为有这样一次次的“事后诸葛亮”会议,才让团队成员能从中总结成功经验,吸取失败教训。从大厂对软件工程实践中,你可以学习到一个优秀的公司是如何来应用软件工程,打造出高质量产品的,也可以借鉴其中好的实践到你自己的项目中。最后要清楚,即便是大厂,对软件工程的应用也不是一成不变的,会随着技术的发展、软件工程的发展不断改进。

qq_44778824的博客 1620

DocuWare平台——用于文档管理和工作流程自动化的内容服务平台详细介绍(上)

DocuWare 客户端是您完成大部分与文档相关工作的地方。在工作区域之间切换以归档、查找和编辑文档。众多功能和自动化流程可以帮助您以结构化的方式快速地执行所有任务。您还可以直接从 DocuWare 客户端打开配置管理器,从而使您可以自定义应用程序或添加新的应用程序。独立、移动工作随时随地访问您需要的信息。保持正在进行的工作流,并在家中或旅途中继续处理您的任务。您所需要做的是选择浏览器和登录 DocuWare 的互联网连接。

qq_43653083的博客 878

文档自动化:保持AI项目文档的实时更新

文档自动化:保持AI项目文档的实时更新 关键词:文档自动化、AI项目文档、实时更新、自然语言处理、机器学习、数据流处理 摘要:本文旨在探讨如何通过文档自动化技术,实现AI项目文档的实时更新。文章首先介绍了文档自动化的背景和问题,随后

AI天才研究院 1709

自动化改变金融科技文档生命周期

金融科技公司可以通过利用文档自动化和适当的技术来重塑处理文档生命周期的方式,以节省时间、消除错误并保持领先地位。

励志做最业余的专业博主,控件产品可以私我~ 1001

北航991软件工程考研初复试完整代码与笔记资料包

北航(北京航空航天大学)计算机学院软件工程方向的考研科目“991软件工程专业基础综合”,作为计算机类研究生入学考试的重要组成部分,近年来吸引了大量有志于深造的考生。本科目涵盖内容广泛,既注重软件工程理论基础,也强调编程实践能力,是区分考生综合素养的关键科目之一。考试内容主要包括《软件工程》、《操作系统》、《计算机网络》和《计算机组成原理》四大模块。其中,软件工程作为核心考查方向,要求考生掌握软件生命周期、开发模型、质量保证、项目管理等基础理论,并具备一定的系统建模与设计能力。

weixin_28809949的博客 1160

《软件工程》课程笔记

软件生命周期:定义阶段,开发阶段和维护阶段 定义阶段:软件计划,需求分析 开发阶段:设计,编码,测试 维护阶段:维护

Python办公自动化之Word文档自动化:全网最全,看这一篇就够了!

作者丨超级大洋葱806来源丨杰哥的IT之旅https://blog.youkuaiyun.com/u014779536/article/details/108418066环境安装 使用Python操作word大部分情况都是写操作,也有少许情况会用到读操作,在本次教程中都会进行讲解,本次课程主要用到以下4个库,请大家提前安装。升级pip(便于安装最新库)python-mpipinstall-Upip...

cainiao_python的博客 2787

自动化文档工具

工具可以通过schema文件生成数据库文档,通过路由文件、接口代码、注释等生成接口文档,每次commit自动更新文档,让人专注于代码编写。

软件工程文档生成工具

在软件工程领域,产品工程文档通常主要包括实施方案、需求分析、软件设计、测试报告、用户手册等几种。这些文档中,通常要求内容丰富,能够体现整个软件工程大部分信息;易于理解,需要制作各种表格,绘制各种图形,包括UML图。可见,文档撰写的工作量巨大,需要有工具支撑,以提高工作效率。 如果开展的项目多,这就是节约人力 ABT文档生成工具软件 概述 在软件工程领域,产品工程文档通常主要包括实施方案、需求...

tohjs的专栏 2727

保姆级教程:用dnSpy调试Unity游戏,从找DLL到打断点全流程(附调试版mono.dll下载)

本文详细介绍了使用dnSpy调试Unity游戏的全流程,包括环境准备、关键程序集定位、mono.dll版本匹配与替换、调试环境配置及实战技巧。通过本教程,开发者可以高效进行Unity游戏逆向分析,适用于学习设计模式或安全审计等场景。

weixin_30236595的博客 578

别再为EPI形变头疼了!FSL的topup+eddy实战保姆级教程(含AP/PA数据采集要点)

本文详细介绍了如何使用FSL的topup和eddy工具解决EPI形变问题,包括数据采集要点、参数设置和实战操作步骤。通过AP/PA双编码数据和精确的形变场估计,有效矫正MRI图像中的几何畸变,提升弥散数据质量。特别适合需要处理高场强MRI数据的研究人员和技术人员。

weixin_28725949的博客 403

11-Claude code 项目规划、测试、代码审查实战

本文介绍了如何利用AI工具Claude Code完成软件工程全流程管理,从项目规划到代码交付。主要内容包括: AI驱动项目管理框架 覆盖需求分析、架构设计、开发实现、测试验证等全流程 Claude Code在各阶段提供规划文件生成、批量编码、测试套件生成等功能 项目规划实践 需求拆解:自动生成功能清单和技术选型建议 架构设计:输出系统架构图、数据库Schema和API设计 任务分解:按优先级和依赖关系生成详细开发计划 技术实现示例 展示在线笔记应用的完整技术架构文档 包含系统分层设计、数据库表结构和API端

an845410111的博客 477

音频降采样系数

如果需要把8K, 16K, 32K, 48K采样率的音频数据降为4K的音频数据, 最简单的方法根据降频倍数来取点, 但是线性度不好. 另一种线性度好一点的方法是: 取适当个数的点数, 各点乘以各自点的系数, 然后相加取平均值. 降频倍数与系数的关系如下: 2倍:     {0.3, 0.4, 0.3} 4倍:    {0.15, 0.2, 0.3, 0.2, 0.15} 8倍:   {0

joans123的专栏 4647

软件工程笔记一

概括地说,软件工程是指导计算机软件开发和维护的工程学科。采用工程的概念、原理、技术和方法来开发与维护软件,把经过时间考验而证明正确的管理技术和当前能够得到的最好的技术方法结合起来,以经济地开发出高质量的软件并有效地维护它,这就是软件工程。Boehm:运用现代科学技术知识来设计并构造计算机程序及为开发、运行和维护这些程序所必需的相关文件资料。IEEE: 软件工程是开发、运行、维护和修复软件的系统方法。

m0_74027860的博客 1903

手把手教你用Cesium和RayMarching实现逼真体积云(附完整Shader代码)

本文详细介绍了如何利用Cesium和RayMarching技术实现逼真的体积云效果,包括环境准备、核心逻辑、云层建模和光照增强等关键步骤,并提供了完整的Shader代码。通过噪声函数选型、动态风场模拟和多重散射近似等技术,开发者可以在数字地球可视化项目中创建沉浸式天气效果,显著提升场景的真实感。

weixin_29230649的博客 419

亿佰特E77模块(STM32WLE5CCU6)LoRa通信实战指南:从配置到应用开发

本文详细介绍了亿佰特E77模块(STM32WLE5CCU6)的LoRa通信实战指南,从硬件配置到应用开发。基于ARM Cortex-M4内核的E77模块集成了LoRa射频前端,具备超低功耗和硬件级抗干扰特性,适用于智能农业、工业现场等场景。文章提供了开发环境搭建、LoRa参数配置、实战通信及性能优化等实用技巧,帮助开发者快速掌握LoRa通信技术。

weixin_29164185的博客 762

软件工程之美-笔记

软件工程之美 项目生命周期 规划 需求分析 设计 编码 测试 运行和维护 软件项目管理金三角 时间 范围 成本 全面提升软件工程能力与实践,打造可信的高质量产品 软件工程的核心 软件工程 = 工具 + 方法 + 过程 做中学 和 教中学 推荐配套书单 构建法 作者邹欣是微软的研发总监,同时在多所高校进行了软件工程的教学实践,在此基础上对软 件工程的各个知识点和技能要求进行了系统性整理,形成教材。也是本专栏很多很好的补 充。 人月神话 这是软件工程历史上的经典著作,内容发人深省,4

不懂先生的博客 4821

消灭 qRFC 队列 Generic stop 错误——SAP CRM 中间件 SMQ1 排障与根因分析全景指南

并不可怕,可怕的是缺乏对 qRFC 状态机的整体把握。通过本文,你不仅看到一个简单的“删表记录就好”的技巧,还能理解:为什么系统要用通用停用而不是显示具体错误;如何定位sg_lock的赋值源头;如何借助监控把被动救火变为主动防火。下一次当 SMQ1 再次闪红,你只需从容执行本文提到的排障脚本,就能把停着的队列重新拉上正轨。参考文献SAP 社区博客 “An example to fix Generic stop set error status in tcode SMQ1”(STOP。

2007 年 ~ 2025 年,深耕 SAP 技术 18 年 812

软件工程课程笔记(1):软件工程概述

软件工程课程笔记(1):软件工程概述 1、软件危机 1.1 什么是软件危机 ​ 软件危机是指在计算机软件的开发和维护过程中所遇到的一系列严重问题。这些问题绝不仅仅是不能正常运行的软件才具有的。实际上,几乎所有软件都不同程度地存在这些问题。概括地说,软件危机包含下述两方面的问题:如何开发软件,以满足对软件日益增长的需求;如何维护数量不断膨胀的已有软件。鉴于软件危机的长期性和症状不明显的特征,近年来...

luoru的博客 1057

AI快速变现之路,AI视频创作

初期投入$3000(工具订阅+样片制作),重点攻克跨境电商和本地生活服务市场。关注2025年AIGC视频工具的API降价趋势(如Pika企业版折扣可达50%),建议与云服务商签订长期合作协议。

qq_29896351的博客 1985

YOLOv11架构革新:华为VanillaNet与BiFPN深度融合的突破性改进实战指南

购买即可解锁300+YOLO优化文章,并且还有海量深度学习复现项目,价格仅需两杯奶茶的钱,别人有的本专栏也有!

LXY_LOVE36的博客 138

《软件工程》——期末复习笔记(软件工程学概述、可行性研究、需求分析、总体设计、详细设计)

期末复习计划:软件工程学概述、可行性研究、需求分析、总体设计、详细设计

南溟北辰往的博客 2130

汉书HE8,好用的汇编代码编写工具

汉书HE8,好用的汇编代码编写工具早期编写汇编代码所用功能强大

软件工程复习笔记

提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档 文章目录1、软件工程概论(1)背景:软件危机表现方法软件工程管理软件工程技术原因(2)软件工程定义三要素生命周期软件定义软件开发运行维护2、过程模型(1)瀑布模型特点优点缺点适用场合(2)增量模型特点同步开发,最后继承优点缺点(3)快速原型特点优点缺点(4)螺旋模型特点适用情况优点缺点(5)喷泉模型优点缺点3、需求获取(1)软件需求什么是软件需求?软件需求的类别功能质量约束(2)获取需求的方法需求获取基于方法(3)需求分析需求可视化结构化分

weixin_43481234的博客 4670

锂电池充电器电路设计 里面有电路

锂电池充电器电路设计 里面有电路 3.7V升压到5V电路设计。

Devexpress16.2.6破解工具

Devexpress16.2.6破解工具Devexpress16.2.6破解工具Devexpress16.2.6破解工具Devexpress16.2.6破解工具

软件工程笔记

1.1 软件的概念与特点 软件概念定义 软件=程序+数据+文档 程序:按照事先设计的功能和性能需求执行的指令序列 数据:是程序能正常操纵信息的数据结构 文档:与程序开发、维护和使用有关的图文材料 软件的特征 软件是设计开发的或者是工程化的,并不是制造的 软件开发时间和工作量难以估计 软件会多次修改 软件的开发进度几乎没有客观衡量标准 软件测试非常困难 软件不会磨损和老化 软件维护容易产生新的问题 按软件的功能进行划分 系统软件:服务于

HLXchamp的博客 1292

efm32 入门.pdf

本PDF共计22页,介绍的是操作驱动API,下载与否自己斟酌。

《Google软件工程》读书笔记

存在更多隐藏的假设被注入程序当中。工程师不太可能有此类任务的相关经验。升级的规模比较大,而非渐进式的。海勒姆定律:当一个API有足够多的用户时,在约定中你所承诺的已不重要:所有在你系统里面被观察到的行为都会被一些用户所依赖。在代码的预期寿命内,我们能够对依赖关系、技术或者产品需求的变化做出响应时,软件是可持续的。文档是指工程师为了完成工作而需要编写的所有补充文本,不仅包括独立文档,还有代码注释。更少的调试。增强变更的信心。改进的文档。更简单的评审。深思熟虑的设计。

生活在别处 3223
上一篇: 软件工程笔记:典型自动化方法和工具
下一篇: 软件工程笔记:测试自动化
Wang's Blog
博客等级 码龄12年 7440粉丝 2427原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Wang's Blog

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值