• 我们学习如何编写代码并构建一些很酷的应用程序，然后我们了解架构以及如何使应用程序可维护多年......但是，当我们需要向其他人（新开发人员，产品所有者，投资者......）解释应用程序如何工作时，我们需要更多......我们需要文档。但是我们有哪些文档选项可以表达整个应用程序
  • 经常看到在产品管理和用户体验设计环境中讨论产品思维，但还没有看到它应用于技术写作和文档。然而，通过将产品思维应用于文档，我们可以编写更有用、相关、高质量的文档。  什么是产品思维？ 产品管理思想领袖 icon
  • Google8号员工和现在的工程高级副总裁UrsHölzle明确说：写作是工 icon
  • 顶顶大名的Redis作者谈如何在Redis这样系统软件上进行代码文档注释，以下是九种注释类型的大意说明： 很长一段时间以来，我一直想在YouTube上发布一段“如何对系统软件文档注释”的新视频，讨论如何进行代码注释，然而，经过一番思考后，我意识到这个主题更 icon
  • 架构决策记录(ADR) 是一个记录重要架构决策及其上下文和后果的文档。架构决策(AD) 是解决重要需求的软件设计选择。架构决策日志(ADL) 是为特定项目（或组织）创建和维护的所有 ADR 的集合。架构重要需求( ASR) 是对软件系统架构具有可衡量影响的需求。 icon
  • Mermaid 可让您使用文本和代码创建图表和可视化效果。它是一种基于 Javascript 的图表和图表工具，可呈现受 Markdown 启发的文本定义以动态创建和修改图表。如果您熟悉 Markdown，那么学习 icon
  • 近来公司需要写软件开发文档，文档主要是用来指导开发人员作实际开发用的，之前自己是coder，现在写这种文档不知道如何下手，从哪几个几角度，需要画什么图，都不是很清楚，希望各位指教！ icon
  • Eltjo Poort 是 CGI 荷兰的架构实践负责人，在软件行业拥有超过 30 年的经验。Eltjo 首先解释了架构上下文和业务驱动程序的重要性，它们可以帮助架构师理解不同的权衡和选项，以便做出正确的架构决策。Eltjo 分享了架构师的主要职责，以及架构师应如何通过了解架 icon
  • 软件架构文档创造了共同的理解（在同一种语境上下文BC中的达成共识） 软件架构文档至少应该支持开发团队，例如，当一个 icon
  • 将文档放在代码旁边非常棒，nai 有丰富的视觉效果和几十个插件，可以在构建时嵌入内容。特点： 带有自定义扩展和数十个插件的 Markdown： 来自外部文件的内容，带有标记和过滤器支持 函数体内容的简化提取（使用示例） 嵌入 JavaD icon
  • 引入DDD之后,详细设计文档应该写?有没有随之对应的一套文档? 原来主要是针对类的设计和类的操作,但是现在一切都变了,业务都变成了服务,那详细设计里面是否要写这些服务?一头务水~ icon
  • 许多技术问题最终会变成人的问题，缺乏良好的文档也不例外。编写和维护文档是一种需要鼓励和培养的习惯。不幸的事实是，如果没有文档文化，再多的工具也无济于事。今天，我们将看看 3 家高性能工程公司，Google、Twitter 和 Spotify，如何处理他们的技术文档并建立文档文化。 < icon
  • 将文档连接到代码并接收警报以在代码更改时更新您的文档。 icon
  • Rewrap 命令是：Rewrap Comment / Text，默认绑定到 Alt+Q. 将光标置于注释块中，点击此按钮可将内容重新换行到  icon
  • 图书馆管理系统是迄今为止最常见的软件开发项目之一。在本文中，我们将从头开始为最后一年的学生制作图书馆管理系统软件开发项目。我们将介绍您在开发该项目时必须执行的所有步骤。 第 1 步 - 团队组建阶段：创建充满活力的团队最后一年项目的团队组建是一个至 icon
  • 在本博客中，您将了解 Spring Configuration Property Documenter Maven 插件，它可以为您解决这个问题。 几乎每个 Spring（启动）应用程序都会使用配置属性。这些配置属性确保应用程序中的某些项目可以通过 app icon