如果让 G 哥用三句话总结语雀,那么应该就是:
适合程序员的 Web 原生文档工具
在线化文档协作平台
优秀的知识管理平台
适合程序员的 Web 原生文档工具
语雀最早是程序员自己为了自己的需求来开发的工具,所以整体很贴合程序员的场景和习惯。G哥想以系分文档举例说一下。
对于阿里来讲,系分文档比较看重的,一是结构完整,需要按照模板进行撰写;二是内容清晰,需要用各种架构图、代码块把事情讲清楚;三是方便协同,评审前后的文档版本要管理好。
自定义可复用模版
目前语雀模板中心有一个系分文档样例,和大部分阿里内部团队使用的模板差不多。同样的,G 哥常使用的缺陷管理、故障复盘、工作周 ,也都在模板中心能找到。
如果官方提供的模板不太符合你的需求,也可以根据公司和团队的情况,来自定义模板。
上面这份示意的概要设计包括总体设计、各子系统设计,其中子系统设计到对应的领域模型,基于分层的时序图、数据库设计、功能列表描述等。
文档归类整理
做项目的同学都知道,项目产出物之间存在衔接关系。比如系分文档常常连带需要有需求规格说明书、测分文档、验收文档等等。这些文档的关联关系如何更好“记录” 或者便于查找strong>
N年前笔者所在的公司是通过目录管理,不同文档放在不同目录中。目录列表下面的内容不多的时候,查找问题不大,多起来的时候就比较费劲,而且文档标题大差不差,用搜索也很难快速定位。
来阿里大家都用的是语雀,文档用多层级的树状目录组织起来,一个项目里的内容放到一个库里,一眼就能找到自己需要的文档。
另外,在文档里面插入其他文档的时候,语雀可以更快捷地把最紧密的文档关联起来,支持多种方式展示。当然搜索功能也是语雀的一大特点,暂不展开。下图就是系分文档中引用需求文档的示意。
除了卡片模式以外,还可以切换成链接或者直接嵌入文档的形式:
能画图的文档
G哥最离不开语雀的一点,是它内置的画图工具。
传统的本地文档甚至 Web 化的文档不少都是采用插入图片的形式,只能在其他软件做完图以后再插入到文档里面来,多费一些功夫不说,如果图需要改,还需要再打开绘图工具,找到之前做好的图,改完,导出,再替换。
另外,这些图片常常没有纳入版本管理,团队多人合作是个问题。如果是架构设计文档,其生命力更长,1年之后还有变更增补,图形源文件找不到就麻烦了。
想想阿里内部应该也曾经因为这个问题头疼,所以语雀这个文档产品会做画板、UML绘图这种画图工具。
另外,不喜欢在排版上花太多时间,喜欢精确性写代码的同学,还可以直接用代码来编写UML类图,我们来看一个例子。
这个文本绘图支持 PlantUML、Mermaid 等四种格式。
系分文档里面常常还要放一些代码块,语雀的代码块支持很多种语言,另外也有 6 种不同的主题可以选择,大家可以自己去体验一下,这里就不做展开了。
在阿里,语雀已经成为产品研发过程中各类文档的标准平台,业务同学、行政同学也都习惯用语雀来做部门内的各种文档管理。
在线化文档协作平台
一是产研文档一定会用到的评审功能,邀请其他相关人员一起异步看方案。
问题不太大的时候基本也不用再拉会,大家在文档里面标记评论就能解释清楚,减少会议成本。
语雀有一些 API 可以打通消息到钉钉群,有信息也都能及时处理。
另外还有一个很重要但容易被忽略的部分:多人协同的场景下,版本管理非常重要,因为有权限修改文档的人太多,到底是谁做了哪些修改,评审好要照着做的版本又是哪一版,都容易引发撕逼。
除了自动保存的文档记录,语雀有一个版本功能,可以把每个节点的文档生成一个版本,版本之间可以进行内容对比,而且每个版本有独立的版本链接,记录每次修订的内容,方便追溯。
优秀的知识管理平台
刚进阿里的时候,遇到一些问题也不好意思老问师哥师姐,试着在语雀搜了下,发现在语雀上其实能搜到很多问题的解法,后面发现,很多阿里的技术人都会在语雀写一些自己的技术实践,于是新人们也都养成了有问题先上语雀的心智。
后面很多技术人离开阿里,也有很多人把这个习惯带到了对外版的语雀。
G哥觉得,语雀的知识管理想象力还挺大的。大量的程序员在用语雀,不少设计人也在用。甚至不同工种的同类人聚在一起,也可以有属于他们的知识库。
在喊出人人都是独特的存在的时代,任何个体都有自己的声音,任何一位程序员也可以有自己的知识体系。系统化这个词就往往和P7层级相关联。大家都知道阿里的P5/P6/P7 标准。P5在主管的帮助下可以独立完成工作,P6是自己独立能够承担一条业务线的产品的迭代和推进的,中等规模/复杂度的系分,独当一面,优秀的系统owner。P7是某个小领域的领域专家。能在一个细分领域有所专精,必然要有个人的知识体系,具有一定的知识厚度和广度。而使用语雀,既可以做好个人沉淀,也可以加强和其他团队成员的互通,得到反馈。
在语雀上,知识库是知识内容的载体,就好比一本书一样,你可以在知识库里对知识内容进行重新组织和分类,可以覆盖项目文档/日 /周 /博客等不同场景。
个人blog
一位叫“邦帮的小小哥”的用户在语雀上写blog。下图为他整理的知识体系树。语雀的知识库功能,让很多文档天然具备结构化,这让每个知识库都相当于一棵树,这一棵棵树正在成为一片森林。目前这片森林里,存在很多孤树,用户很容易迷路。把尽可能多的树连接起来,让用户能在知识森林中愉悦散步,语雀还有很长的路要走。
读书笔记
写读书笔记,也有现成的模版可以用,其中还可以嵌入各种格式的外部链接,比如豆瓣。
从思维导图、到ppt、再到写专栏
下图是笔者整理的一个《系统稳定性》分享大纲的局部。这次我使用语雀而不是直接写ppt的方式向兄弟团队做分享,也是一次尝试。
我的步骤是这样的:
1、把想法沉淀为思维导图
2、把思维导图按二级标题结构化
3、不断完善案例
第二次分享在第一次分享的基础上就把服务分级和隔离进行了一些细化。
或者这份思维导图、文档,某一天对外可以形成ppt,形成系列的专栏文章,也未可知。
对了,秀一下你的创作指数呢,也是满满的成就感呢。
总结
在阿里内部有100000人以上的人在使用。外部使用情况呢可以搜索到从2018年对外到2021年9月数据,语雀的用户每年成倍增长,包括公司和小组在内的有效组织数达55万,个人用户超过540万。
有没有一款适合程序员的云端工具,我觉得语雀不错。如果你把它和笔记工具比较,小瞧它了。真正实现“文档 Web 原生化” ,适合产品经理写需求规格说明书,程序员写设计文档,QA写测试用例,运营写运营手册。
还具有个人博客,知识结构化的能力。同时适合公司内项目协作,产品需求文档已经写在了语雀上,基于文档进行高效评审、基于文档能追踪需求变更等等。还有朋友把产品文档直接通过语雀分享给他的客户,甚至通过开放权限来实现客户文档共建。快速协作、知识流动,让一切皆有可能。
文章知识点与官方知识档案匹配,可进一步学习相关知识Java技能树首页概览92992 人正在系统学习中
声明:本站部分文章及图片源自用户投稿,如本站任何资料有侵权请您尽早请联系jinwei@zod.com.cn进行处理,非常感谢!