夜雨聆风学习资料网

ARTICLE · 1113620

企业应该要有一个独立的文档系统

发布时间：2026-10-02 11:52:54 最近访问：2026-10-02 11:52:54
企业应该要有一个独立的文档系统
受前面笔记项目的启发，公司现在API文档+数据库文档+设计文档+升级文档，都是apifox+showdoc组合使用，showdoc还好是开源的内部部署，但是apifox就是使用的商业软件。
这里就有个问题，我们现在是完全信任商业软件提供方，但是谁又能堤防的了它们商业软件的研发和运维人员不外露数据？
懂的都懂，说白了、人怕出名猪怕壮，这些东西就不能给它们卡脖子的机会、让其有可能对我们的资料为所欲为。
假如哪天，它们的运维偷偷的把资料“卖给”我们的竞争方，这还怎么竞争？
so 基于此背景，就让AI开发了一个“API（TCP/MQTT/gRPC等含各种协议的测试）文档+数据库文档+设计文档+升级文档”集所有软件开发公司需要的文档功能于一身的系统。
我们姑且叫它：文件系统
技术栈：
jdk17+SpringBoot3+Vue3+MySQL8+Docker Compose
因为是让AI开发的，这里就不扯具体的实现细节，只聊需求，项目已经开源：
https://gitee.com/sean_project/apidoc.git
感兴趣的同学可以去看下。
具体效果：
  1. 用户可以注册、登录；
  2. 登录进去后可以创建项目、或者选择已有项目；
3. 进入项目后就可以实现对这个项目的所有资源进行操作：
  1. 项目概况，接口、状态码、项目文档和项目成员数量统计；
  2. 项目接口列表，主要是所有接口的呈现，重点是接口里面的操作；
    1. 接口请求和响应参数定义、示例；
    2. 前面的示例可以作为测试输入，并且可以修改并测试接口数据，测试结果作为历史请求和响应，该结果也可以作为测试回填、再次请求等。
  3. 状态码，为什么会有这个？2个目的：
    1. 是对端开发可以参考对应错误码做业务处理；
    2. 是运维可以基于错误码处理用户问题。
  4. 项目文档，这里主要是涵盖：数据库文档、设计文档、部署文档，
    1. 数据库文档，支持SQL表结构导入生成列表格式的文档，并且补充文档说明等等，文档也是Markdown所见即所得格式，修改非常顺手；
    2. 设计文档，纯Markdown格式，所见即所得的编辑模式；
    3. 部署文档，也是纯Markdown格式，同时支持添加其他脚本文件，支持新增多个类型SQL、Shell脚本等。
  5. 环境管理，这里主要是测试接口的时候，可以指定发送到的环境，比如测试环境、研发环境、灰度环境、生产环境等；
  6. 项目成员，这里可以添加相关干系人，成员加进来才能进入项目查看和对应的编辑操作。
以前一个想法要做成系统少则2-3天，多则半个月，现在AI是真方便，小半天就可以做的很好了，而且是超预期效果。
核心思想：企业最好是自己能够抓住所有信息资产，尤其是软件公司，AI之后、竞争力都是非常脆弱的，文档/代码如何保证安全？靠谁都没用。
- end -
芊芊爸爸
一个有趣的程序员

微信扫描二维码，关注我的公众号

相关学习资料