更新 HOME.md
parent
a97167bf60
commit
a2e2055967
16
HOME.md
16
HOME.md
|
@ -17,8 +17,22 @@ $\color{red}{你给我的star,胜过所有读过的诗—smart-doc}$
|
||||||
- 设计的好的接口协议后期的持续更新遗漏,仍然是个问题,人性本是懒惰的。smart-doc能够保持文档和代码的一致性。
|
- 设计的好的接口协议后期的持续更新遗漏,仍然是个问题,人性本是懒惰的。smart-doc能够保持文档和代码的一致性。
|
||||||
- 一个新成员进入团队看代码,html的文档明面比word写的更方便跟踪。新成员完全可以直接上手打开debug文档页面调试熟悉业务。
|
- 一个新成员进入团队看代码,html的文档明面比word写的更方便跟踪。新成员完全可以直接上手打开debug文档页面调试熟悉业务。
|
||||||
- smart-doc由于采用源码分析,对代码的标准度要求高于其他工具,使用这个工具直接就能统一团队风格。
|
- smart-doc由于采用源码分析,对代码的标准度要求高于其他工具,使用这个工具直接就能统一团队风格。
|
||||||
|
- 还可以基于smart-doc定制开发,将文档输送到yapi这样类似的接口文档管理中。
|
||||||
|
|
||||||
> 目前国内主流的设计先行的文档方式,主要就是word或者是markdown。
|
> 目前国内主流的设计先行的文档方式,主要就是word或者是markdown。word的翻页对接口展示很不友好。
|
||||||
|
|
||||||
|
## 代码先行
|
||||||
|
代码先行的这种模式,利用smart-doc天然就可以一边写代码一边出接口文档。然后利用smart-doc对代码的规范要求严格度。
|
||||||
|
完全可以保证团队代码风格不会出现很大差异。
|
||||||
|
|
||||||
|
> 代码先行在很多团队是有弊端的,代码先行特别是对大型系统,对代码编写者能力要求很高。
|
||||||
|
代码和业务的结合能力需要非常强,能够考虑到扩展和业务边界。代码先行这种,也可以走另外一种路线,
|
||||||
|
团队的架构师直接搭建好项目框架后,定义好接口框架代码,填充业务逻辑部分全部空出来。有了接口,smart-doc已经可以扫描生成接口文档了
|
||||||
|
|
||||||
|
## 总结
|
||||||
|
总之,使用文档工具和团队采用哪种模式并没有半点关系。工具是为了在某些方面去帮助团队更好的完成工作或者是提高效率。
|
||||||
|
作为技术人员也要向前看,总会有新的技术、新的框架、新的工具出来去解决过去的一些问题。
|
||||||
|
对新事物持有好奇心也是一种人生态度。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue