当前位置:网站首页>远程办公之大家一同实现合作编辑资料和开发文档 | 社区征文
远程办公之大家一同实现合作编辑资料和开发文档 | 社区征文
2022-07-03 16:05:00 【InfoQ】
问题
- 我们相关的一些开发设计文档,该如何实现协同编辑?采用哪种方式进行编辑?如何进行合并以及实时通知大家去修改,完成相关的文档?
- 相关的API设计文档资料:一般而言会分为面向对外的OPEN-API文档,对内的内部开发人员的设计接口定义文档。如何实现有效和合理的文档编写,并且大家都可以同时进行编辑调整?
- 相关的需求文档的控制,不能每一个人到处转发,编辑的修改痕迹,也无法达成统一,并且有些标注,业务无法直接书写留痕,此外针对于人员的通知能力也很难做到,向所有人进行通知。
解答
- 首先,如何实现相关的开发设计文档的协同编辑?那方法就很多了,比如向我们目前公司常用的coding、wiki以及lark自带的编辑文档。
- coding,主要采用的就是比较面向于开发人员角度了,更多的时候,我们会采用它去书写一些设计文档,包含架构图以及内部开发相关的接口设计文档,流程图等等操作控制。
- jira,相信大家并不陌生了,就是针对于一些大家内部开发人员之间针对于系统功能相关的设计文档,也算是一个coding编写相关文档的内部化文档了,还有就是一些相关的信息登记,也我们会采用jira方式编写原因之一。
- lark自带的编辑工具,我们采用的是lark的通讯工具,其实就是我们常说的飞书,它其实是支持相关的在线文档,很类似钉钉的功能,通过lark推送到跨部门群,多部门可对异常数据进行标注,再划分人员对问题进行跟进解决,实现数据化在线协同办公。
- 针对于外部的OPEN-API文档采用的是,vuejs编写的相关的api页面进行展示,也就是相关的开发页面,虽然需要一定的开发成本,但是因为是全局唯一化的,我们采用的git去维护,所以就可以实现相关的协作处理和大家公共开发调整。而另外一方面,我们采用的是jira或者是coding去开发设计,真的样子就可以内部化分享了,代替传统的word文档,简直是方便又便捷。
- 第三点,其实是采用lark去处理的,因为lark自带的文档,是支持企业内部的相关的人员的选择,这样子就不用再进行通知对应的人员,它提供了相关@选择人员之后,直接进行发送通知信息,此外文档还可以添加相关的批注,真的是非常方便啊!
边栏推荐
- pyinstaller不是内部或外部命令,也不是可运行的程序 或批处理文件
- From the 18th line to the first line, the new story of the network security industry
- 《天天数学》连载56:二月二十五日
- 记一次jar包冲突解决过程
- The wonderful use of do{}while()
- Mb10m-asemi rectifier bridge mb10m
- Break through 1million, sword finger 2million!
- Jmeter线程组功能介绍
- Go语言自学系列 | golang中的if else语句
- uploads-labs靶场(附源码分析)(更新中)
猜你喜欢
Q2 encryption market investment and financing report in 2022: gamefi becomes an investment keyword
[redis foundation] understand redis persistence mechanism together (rdb+aof graphic explanation)
From "zero sum game" to "positive sum game", PAAS triggered the third wave of cloud computing
几种常见IO模型的原理
Project -- high concurrency memory pool
C language brush questions ~leetcode and simple questions of niuke.com
Mongodb installation and basic operation
Three dimensional reconstruction of deep learning
Find mapping relationship
Slam learning notes - build a complete gazebo multi machine simulation slam from scratch (I)
随机推荐
Microservice API gateway
Qt插件之自定义插件构建和使用
[combinatorics] combinatorial identities (sum of variable terms 3 combinatorial identities | sum of variable terms 4 combinatorial identities | binomial theorem + derivation to prove combinatorial ide
Function introduction of JMeter thread group
Microservice API gateway zuul
[redis foundation] understand redis persistence mechanism together (rdb+aof graphic explanation)
子类隐藏父类的同名函数
近视:摘镜or配镜?这些问题必须先了解清楚
Microservices Seata distributed transactions
Microservices - load balancing ribbon
记一次jar包冲突解决过程
App mobile terminal test [3] ADB command
UnityShader——MaterialCapture材质捕捉效果 (翡翠斧头)
Using optimistic lock and pessimistic lock in MySQL to realize distributed lock
"Remake Apple product UI with Android" (2) -- silky Appstore card transition animation
WinDbg analysis dump file
uploads-labs靶场(附源码分析)(更新中)
[combinatorics] combinatorial identities (review of eight combinatorial identities | product of combinatorial identities 1 | proof | use scenario | general method for finding combinatorial numbers)
June to - -------
使用AUR下载并安装常用程序