编程设计文档

     

Spring中如何为属性配置文件自动产生文档?

31 6K

在本博客中,您将了解 Spring Configuration Property Documenter Maven 插件,它可以为您解决这个问题。几乎每个 Spring(启动)应用程序都会使用配置属性.

VsCode中给注释说明文字强换行的插件:Rewrap

77

Rewrap 命令是:Rewrap Comment / Text,默认绑定到 Alt+Q. 将光标置于注释块中,点击此按钮可将内容重新换行到 指定的换行列。特征 使用多种语言重新包装注释块,并使用每种.

图书馆管理系统之软件开发项目

61 28K
图书馆管理系统是迄今为止最常见的软件开发项目之一。在本文中,我们将从头开始为最后一年的学生制作图书馆管理系统软件开发项目。我们将介绍您在开发该项目时必须执行的所有步骤。第 1 步 - 团队组建阶段:创.

软件架构文档的终极指南

1415 9K

软件架构文档创造了共同的理解(在同一种语境上下文BC中的达成共识)软件架构文档至少应该支持开发团队,例如,当一个新的团队成员新入职,会有很多问题: 在哪里可以找到系统构建块的概述? 你为什么使用Ang.

什么是架构决策记录 (ADR)?

1893 1 4K

架构决策记录(ADR) 是一个记录重要架构决策及其上下文和后果的文档。架构决策(AD) 是解决重要需求的软件设计选择。架构决策日志(ADL) 是为特定项目(或组织)创建和维护的所有 ADR 的集合。架.

znai: 使用Markdown编写Java文档系统

1253

将文档放在代码旁边非常棒,nai 有丰富的视觉效果和几十个插件,可以在构建时嵌入内容。特点: 带有自定义扩展和数十个插件的 Markdown: 来自外部文件的内容,带有标记和过滤器支持 函数体内容的简.

以产品思维方式编写更好的文档

7020 8K
经常看到在产品管理和用户体验设计环境中讨论产品思维,但还没有看到它应用于技术写作和文档。然而,通过将产品思维应用于文档,我们可以编写更有用、相关、高质量的文档。 什么是产品思维? 产品管理思想领袖Sh.

Vscode插件:将代码连接到IDE中的文档

864
将文档连接到代码并接收警报以在代码更改时更新您的文档。安装:https ://marketplace.visualstudio.com/items?itemName=mintlify.connecto.

架构就是上下文 - Eltjo

956 1 2K

Eltjo Poort 是 CGI 荷兰的架构实践负责人,在软件行业拥有超过 30 年的经验。Eltjo 首先解释了架构上下文和业务驱动程序的重要性,它们可以帮助架构师理解不同的权衡和选项,以便做出正.

Google、Twitter 和 Spotify 如何建立文档文化 - DEV

953 3K

许多技术问题最终会变成人的问题,缺乏良好的文档也不例外。编写和维护文档是一种需要鼓励和培养的习惯。不幸的事实是,如果没有文档文化,再多的工具也无济于事。今天,我们将看看 3 家高性能工程公司,Goog.

mermaid - 用于生成流程图、序列图、类图、甘特图和git图的Markdownish语法。

2303
Mermaid 可让您使用文本和代码创建图表和可视化效果。它是一种基于 Javascript 的图表和图表工具,可呈现受 Markdown 启发的文本定义以动态创建和修改图表。如果您熟悉 Markdo.

刚刚大幅度裁员的Uber文章:软件架构被高估,清晰和简单的设计被低估 - Gergely Orosz

2517 2 7K

我在设计和构建大型系统方面获得了公平的份额。我参与了重写Uber的分布式支付系统,在Xbox One上设计和发布Skype以及开源RIB,Uber的移动架构框架。所有这些系统都经过了彻底的设计,经历了.

软件架构文档记录大全 – @herbertograca

2357 4 11K
我们学习如何编写代码并构建一些很酷的应用程序,然后我们了解架构以及如何使应用程序可维护多年......但是,当我们需要向其他人(新开发人员,产品所有者,投资者......)解释应用程序如何工作时,我们.

写作是软件工程师重要的超能 - Gergely Orosz

1404 2

Google8号员工和现在的工程高级副总裁UrsHölzle明确说:写作是工程师重要的超能。  工程师经常低估写作的重要性。投资这项技能,以扩大您向其他人传达信息的能力,成为更有影响力的工程师。大多数.

Redis作者谈如何编写系统软件的代码注释

1331 2 8K

顶顶大名的Redis作者谈如何在Redis这样系统软件上进行代码文档注释,以下是九种注释类型的大意说明:很长一段时间以来,我一直想在YouTube上发布一段“如何对系统软件文档注释”的新视频,讨论如何.

对于DDD,其中的各项文档怎么写?

3 1138

引入DDD之后,详细设计文档应该写?有没有随之对应的一套文档?原来主要是针对类的设计和类的操作,但是现在一切都变了,业务都变成了服务,那详细设计里面是否要写这些服务?一头务水~.

软件开发设计文档

1 2083

近来公司需要写软件开发文档,文档主要是用来指导开发人员作实际开发用的,之前自己是coder,现在写这种文档不知道如何下手,从哪几个几角度,需要画什么图,都不是很清楚,希望各位指教!.