远程办公之大家一同实现合作编辑资料和开发文档 | 社区征文

磨难压不垮、奋起正当时。在举国上下万众一心、众志成城做好新冠肺炎疫情防控工作的特殊时刻。

大家好，在疫情出现的时候，很多人可能都会被迫留在了家里办公，在家办公固然好，但是很多资源还都在公司内，所以还是后很多不方便的地方啊，那如何解决这些问题呢，所谓如果要解决问题，那么最好的办法就是先去梳理好所以的问题，那么我们现在看看有哪些问题在？

问题

当大家都在家里办公的时候编辑相关的文档或者修改相关资料的时候是很头疼的事情：

• 我们相关的一些开发设计文档，该如何实现协同编辑？采用哪种方式进行编辑?如何进行合并以及实时通知大家去修改，完成相关的文档？

• 相关的API设计文档资料：一般而言会分为面向对外的OPEN-API文档，对内的内部开发人员的设计接口定义文档。如何实现有效和合理的文档编写，并且大家都可以同时进行编辑调整？

• 相关的需求文档的控制，不能每一个人到处转发，编辑的修改痕迹，也无法达成统一，并且有些标注，业务无法直接书写留痕，此外针对于人员的通知能力也很难做到，向所有人进行通知。

解答

遇到问题，我们就要解决问题，对吧，接下来我就针对于这几个问题，进行总结相关的实现方案。

• 首先，如何实现相关的开发设计文档的协同编辑？那方法就很多了，比如向我们目前公司常用的coding、wiki以及lark自带的编辑文档。

• coding，主要采用的就是比较面向于开发人员角度了，更多的时候，我们会采用它去书写一些设计文档，包含架构图以及内部开发相关的接口设计文档，流程图等等操作控制。

• jira，相信大家并不陌生了，就是针对于一些大家内部开发人员之间针对于系统功能相关的设计文档，也算是一个coding编写相关文档的内部化文档了，还有就是一些相关的信息登记，也我们会采用jira方式编写原因之一。

• lark自带的编辑工具，我们采用的是lark的通讯工具，其实就是我们常说的飞书，它其实是支持相关的在线文档，很类似钉钉的功能，通过lark推送到跨部门群，多部门可对异常数据进行标注，再划分人员对问题进行跟进解决，实现数据化在线协同办公。

• 针对于外部的OPEN-API文档采用的是，vuejs编写的相关的api页面进行展示，也就是相关的开发页面，虽然需要一定的开发成本，但是因为是全局唯一化的，我们采用的git去维护，所以就可以实现相关的协作处理和大家公共开发调整。而另外一方面，我们采用的是jira或者是coding去开发设计，真的样子就可以内部化分享了，代替传统的word文档，简直是方便又便捷。

• 第三点，其实是采用lark去处理的，因为lark自带的文档，是支持企业内部的相关的人员的选择，这样子就不用再进行通知对应的人员，它提供了相关@选择人员之后，直接进行发送通知信息，此外文档还可以添加相关的批注，真的是非常方便啊！

希望我们可以渡过难关，战胜疫情！