艾动科技发布在线技术文档
传统技术文档基本都是在Word中编写,再通过PDF或chm跟随安装盘一起分发。随着越来越多的合作伙伴加入,我们开始发现传统的技术文档分发方式给我们带来的很多限制:
1 更新不及时
2 新功能不能快速传递
3 发现文档错误没有地方反馈和更新
4 ......
目前更多互联网公司的文档都是基于 Markdown + GitHub + 文档框架编写和管理,通过CICD自动部署到自家服务或第三方服务,文档向所有人开放,任何人都可以贡献,当然,目前主要贡献还是自家员工,整个过程专注、开放、透明、快速和及时。我们按照这样的技术路线重新整理了imgenius文档,从今年1月到5月(实际是从春节后正式开始),8位贡献者利用工作空闲时间,534次提交就完成所有文档的编写和部署,整个过程非常快速。且搭建好这个框架后,以后的协作和更新将会更加及时。
艾动科技CTO洪志兵说,“不仅文档,开源和内部开源已经被证实是一套可行的方案,在2c和2b企业都有采用,我们也希望采用内部开源的方式,快速和高效地为用户提供高质量、创新型应用。我们所说的内部,不仅仅是我们公司,还包括合作伙伴、最终用户,欢迎更多的合作伙伴加入我们。”
点击可访问在线文档。
更多信息,请联系我们。