diff --git a/HOME.md b/HOME.md index fb2be5d..c6e3301 100644 --- a/HOME.md +++ b/HOME.md @@ -2,4 +2,26 @@ smart-doc官方文档,文档已经将smart-doc的所以使用配置及使用 当然也希望多给我们一些开源支持,点点star。 -$\color{red}{你给我的star,胜过所有读过的诗—smart-doc}$ \ No newline at end of file +$\color{red}{你给我的star,胜过所有读过的诗—smart-doc}$ + +# 设计先行和代码先行影响使用smart-doc吗? + +一些老派的程序员或者所谓有多年经验的架构师觉得,smart-doc这种基于代码扫描工具对于设计先行的开发模式没有就没有作用了。 +真的是这样的吗?我们来看看吧。 +## 设计先行模式 +- 由比较有经验的人编写设计文档和接口协议。 +- 完成设计后主要由业务开发工程师根据设计文档开发业务逻辑。 +- 架构师也可以像国外一些架构师一下,直接定义好程序的接口框架,然后交付给业务工程师填充业务代码。 + +设计先行通常在成熟的开发团队中。在代码先行模式下,接口协议虽然在设计阶段都已经定义好。但是smart-doc仍然很有用。 +- 设计的好的接口协议后期的持续更新遗漏,仍然是个问题,人性本是懒惰的。smart-doc能够保持文档和代码的一致性。 +- 一个新成员进入团队看代码,html的文档明面比word写的更方便跟踪。新成员完全可以直接上手打开debug文档页面调试熟悉业务。 +- smart-doc由于采用源码分析,对代码的标准度要求高于其他工具,使用这个工具直接就能统一团队风格。 + +> 目前国内主流的设计先行的文档方式,主要就是word或者是markdown。 + + + + + +