项目文档管理工具开发实践

考虑到楼可能比较多，我把上传的工程文件放在最上边了，方便大家下载

0001_白泽_8.0.4.0.fgcc (4.71 MB, 下载次数: 90)

2022-8-23 00:06 上传

点击文件名下载附件
0002_白泽_8.0.4.0.fgcc (4.71 MB, 下载次数: 91)

2022-8-23 00:06 上传

点击文件名下载附件
0003_白泽_8.0.4.0.fgcc (4.71 MB, 下载次数: 104)

2022-8-26 10:19 上传

点击文件名下载附件
0004_白泽_8.0.4.0.fgcc (4.72 MB, 下载次数: 151)

2022-8-27 20:36 上传

点击文件名下载附件

------------------------------正文-------------------------------

项目文档管理，是指在一个系统（软件）项目开发进程中，将提交的文档进行收集管理的过程。通常，文档管理在项目开发中不是很受重视，当发现其重要性时，往往为时已晚。整个项目可能因此变得管理混乱，问题产生后无据可查。文档管理对于一个项目的顺利进行有着至关重要的作用，其关键性不容忽视。

这话不是我说的，这是度娘说的：项目文档_百度百科 (baidu.com)

可是吧，我们用活字格开发，这个开发文档就是个大问题。活字格和传统的开发不同，她是自成体系的。以前我们传统开发是基于文件的，我们可以随意在开发目录里放文档，可是活字格开发是基于活字格自有的工程文件的，虽然这个工程文件本质上是一个 zip 压缩包，格小新们可以自己试一下，把活字格的工程文件的扩展名改成 .zip，然后你打开这个 zip 包，那些少儿不宜的东西就啥都看见了——住手！你还真改扩展名啊你，听相声在这儿，作死去Wyn内版！

对于格小新们来说，还是要养成写文档的习惯。其实我废这么多话呢，主要是说给格小新们听的，我就是想着干的年头不短了，经验不敢说有多少，咸盐倒是吃了不少，能多说点儿就多说点吧，等哪天我们咽了气了想听还听不着了呢，大佬们的时间宝贵，不用听我这儿闲扯淡。

项目文档啊，除了指导开发，它还是个积累。格小新们用活字格，错误那是没少犯。没少犯是没少犯，问题是同样的错误没少犯。犯了再改，改完再犯，千锤百炼。这要是能在活字格的工程文件里能把项目文档含着，项目开发的全过程都可以跟着记录，然后开一个新的项目工程，还可以把这部分导入到新工程中，这能省好大事啊，而且这做出来的东西它规矩不是？

但是用活字格开发，你说这文档我写哪儿？写 word 里？团伙做案怎么办？不是，我的意思是团队开发，团队开发，嘴秃噜了。一人写一部分？那怎么拼起来呢？然后更新怎么办呢？这是开发文档，不是起点小说还有个断更一说，开发文档一天能更新八百遍！用钉钉或企业微信传来传去吗？你知道传的是哪个版本的？写 git 上呗，是可以，但是，它不方便啊，传统开发还好，就在开发的目录里专门建一个文件夹，起个名字叫 docs，然后文档都放这里，往 git 上一传完事，保证丢不了。可是活字格不行啊，活字格有协同开发啊，协同开发把 git 直接包起来了。还是写到语雀上？写石墨上？要不刻脸上？



你写单元格里呀，每个单元格都能写备注啊。列位，您听这像话吗？写单元格里，我写哪单元格里呀？这一格一格的这不都写碎了吗？我写的是文档啊写的是胡椒面啊？

有写胡椒面的吗？

写页面上行不行呢？当然也不是不行，可是，你自己试试就知道了，那叫一个酸爽，你想这个道理呀，有拿 excel 当 word 用的吗？你能拿改锥楔钉子，你能拿榔头拧螺丝吗？什么工具干什么活。

那要都没有，咱就得另想辙了。

文档的内容我其实可以写在数据表里啊，然后我只要做一个维护的页面，能把表的内容读出来，还能再写回去，这不就得了吗？开发的时候，我需要写文档了，我就把这个维护的页面设置成启动页，然后按一下 F5，就可以写了，写完了保存，回到设计器里继续开发就行了。

文档我是可以写数据表里，可是交互页面上的编辑器用什么呢？用官方的富文本编辑器？这东西吧，不是不能用，嘿嘿，谁用谁知道……

万幸，咱格友 lovert 做了这个 EditorMD插件 ，终于可以在活字格里舒舒服服地用 markdown 写文档了，让我们向 lovert 表达最衷心的敬意和最诚挚的感谢。

这家伙什儿都全了那还等什么呢，开整吧就！您先等会。

这个小工具要叫什么名字呢？

这还有什么名字啊，就叫活字格文档工具啊。您瞧瞧，张嘴就来。这就是项目思维。那甭管谁做的这类的工具不都能叫活字格文档工具吗？那大家要都叫这个，这不就叫乱了吗？咱换一个，咱在项目思维中带入一点点产品思维，咱用做产品的心态来做这个项目。那要是做产品，你这产品可就得有名字了。项目可以没有名字，就叫什么什么项目就行，产品没名字可歇了，所以，得先起个名字。

其实一个项目啊，也应该跟产品一样，从起名字开始，格小新们也要学会起名字。比如你们也都了解活字格，活字格开发的系统登录后，进入的第一个页面，是启动页是吧，但是我要分权限，不同角色权限的人看到的页面不一样，这怎么办？我参考别人的方法，提出了一个名词：首页路由，这个概念很快咱们团队里的人就都接受了，因为大家都能理解。孔子说名不正则言不顺的意思不仅仅是说名义、道义要正，这个“名”也是名称、名字，一件事，你不把这件事起个名字，你就不容易叫它，不容易叫它这个事儿就办不成。

你们看美国电影，是不是特种部队行动时都要起个名字？什么剑鱼行动，雷霆行动，勇者行动，送死行动，要么就给一个行动代号，为什么？因为好叫，互相之间也好理解，也好交流好沟通，即简捷还没有歧义。所以，你们要是当产品经理，一个功能点一定要起个名字。你们逛过宜家吗？宜家是不是所有的产品都有一个名字？我想买一个嗑毛豆专用的小方桌，你上淘宝上怎么搜啊？你搜小方桌？长什么样的都有，把方青卓搜出来都有可能。



可是你要按照产品的名字搜呢？是不是搜出来的结果就靠谱多了？
再​比方说，要在列表页上，在名字的右侧，显示一个箭头，如果排名比昨天上升了，就显示红色向上的箭头，如果下降了就显示绿色下降的箭头，产品经理把这个功能释放了，开发做了，过程中产品问进度时可咋问？

​内个功能做完了吗？哪个功能？就是那个箭头的功能？啥箭头？现实是不是就是这个样子的？可是产品经理在释放需求时如果定义了，这个功能就叫列表红绿灯，是不是大家就都好沟通了？这叫名不正，则言不顺——说的不顺畅嘛。

顺便讲一下名不正则言不顺这个典故。这话在春秋战国之时，有一位莽撞人。

死人姓仲名由字子路。

子路曰：卫君待子而为政，子将奚先？子曰：必也正名乎。子路曰：有是哉？子之迂也。奚其正？！

子曰：野哉！由也。君子于其所不知，盖阙如也。名不正，则言不顺；言不顺，则事不成；事不成，则礼乐不兴；礼乐不兴，则刑罚不中；刑罚不中，则民无所措手足，故君子名之必可言也，言之必可行也。君子于其言，无所苟而已矣！

这是说啊，在公元前485年，66岁的孔子抵达卫国。此时的卫国正面临内乱的前夜。卫灵公有个很宠爱的小老婆，就是大名鼎鼎的南子，言听计从的。但卫灵公的儿子蒯聩，这个字读kuǎi，却对这个后妈怎么看，怎么讨厌。甚至企图发动政变，干掉这个后妈。事情败露后，蒯聩逃往晋国。卫灵公大骂蒯聩不孝，断绝父子关系。

卫灵公死后，将君位传给自己的孙子，也是蒯聩的儿子，就是后来的卫出公。卫出公刚继位，他父亲蒯聩也带兵从晋国跑回卫国，军队正驻扎在卫国边境，准备和自己的儿子争夺君位。

此时正在卫国的孔子，正面临卫国如此的局面。

子路跑来见孔子。父子争夺君位，老师你怎么看？孔子就在这种背景下，说出了著名的: 名不正则言不顺，言不顺则事不成。什么意思呢？孔子的意思是，一个君位难道能大过父子间的亲情吗？父子不能和解吗？

子路一听就笑了。老师啊，你为什么这么迂腐？我就支持卫出公。孔子真的生气了，他告诉子路，你参与卫国内乱，你不得好死。其实孔子这真不是在骂子路。孔子这是预见到了子路的命运。

卫国内乱前夜，孔子最终返回鲁国，结束了其14年周游列国的历史。但子路没走，留在了卫国。子路的结局大家都知道，最终被蒯聩的武士，剁为肉泥。卫出公逃亡鲁国。

你们注意啊，史书是很严谨的，剁为肉泥，就是字面的意思。

子路遇害消息传到鲁国。孔子痛哭流涕。子路何等人物，是孔子的学生兼保镖，亦师亦友，一逗一捧，30多年的感情，两人不离不弃。从此以后，孔子再不吃肉酱。这回明白了吧？剁为肉泥就是字面的意思。

这是名不正则言不顺的背景。这是从政治层面说的。

这叫师出有名，大到改朝换代，小到去单位办事，你得拿个介绍信吧？你啥也没有我知道你是干嘛的？这些都是名不正则言不顺。

当然这是政治上的，那我们理解论语，不能这么简单地去理解。这句话在哲学层面上，就是一个事物如果没有给出一个准确的定义，你就讲不出它内在的道理，讲不出内在的道理你就没法按照它去解决问题。

用数学的角度阐述：一个概念定义不清晰，那就无法证明和阐述清楚跟它有关的一切理论，也无法用它解决实际问题。

咱们用活字格做开发，从起名字开始，因为名不正，则言不顺。

这要叫什么名字呢？我得分析这个货是干什么的吧？你看，起名字，也是你在梳理需求，明确项目的目标的一个过程。这个小工具是写项目文档的，活字格的所有项目文档都写在这里，然后把文档内容记录到数据表中，将来开发过程中有遗忘，上这里找，万一做着做着矫情起来了，看文档。这是上古神兽白泽啊！

白泽不知道？山海经里有啊，这是中国古代神话中的瑞兽啊。《宋书·符瑞志》记载说啊，这话说在黄帝时期，说黄帝东巡，这一天到了滨海新区，一过于家堡啊，哎，遇到一头神兽白泽，白泽是祥瑞之兽，能口吐人言，通万物之情，知鬼神之事，晓天下万物状貌。就说这白泽，嘛都懂，这不就是项目文档吗？

所以，这个小工具的名字就有了，就叫白泽了。

楼主，有一个问题，这个如果想加入图片要怎么操作？

拿来，谢谢！

技术、文采都牛B

技术、文采都牛B，这是两手抓两手都硬啊

更新到了 0004

增加了一个服务端命令，可以在前台由用户操作清空内置表并重置 ID

0004_白泽_8.0.4.0.fgcc (4.72 MB, 下载次数: 103)

2022-8-27 20:38 上传

点击文件名下载附件

开放个分支，让有兴趣的格友一起加入，人多力量大。也许这就是《史上第一个众格友一起参与的项目》。

更新到 V0003，增加了添加文章功能

0003_白泽_8.0.4.0.fgcc (4.71 MB, 下载次数: 84)

2022-8-26 10:21 上传

点击文件名下载附件

这文字功底就是页面太少了

大神这文本，膜拜膜拜