Wiki 文档与 VSCode 完美融合,解放技术文档生产力

305 阅读1分钟

【推荐】安利一款本人开发的非常好用的 VSCode 插件:What's This。右键 'What's this?',无需任何配置,即可整合wiki文档功能到当前项目,解放技术文档生产力,让项目成员间共享技术文档变得so easy!

插件安装

在 VSCode 插件市场搜索并安装 ”What's This“ 插件 企业微信20240406-160645@2x.png

插件用途

整合 wiki 文档功能到 VSCode,提升技术文档的编写速度,降低技术细节的沟通成本,改善技术文档的使用体验,解放技术文档的生产力。

插件开发背景

在多人协作的开发项目中,存在以下痛点:

  1. 在长期的迭代过程中,会陆续新增很多的组件/模块,尽管绝大多数都按大类进行了分类,但这些组件/模块的用途、用法并不直观,导致可能重复开发;
  2. 绝大数项目都普遍缺乏基础的技术文档,新人要基本熟悉项目中的大多数组件/模块,不仅需要付出很多的时间和精力,沟通成本也比较高;
  3. 利用 wiki 工具编写技术文档不仅耗时费力,通常还必须脱离 VSCode,使用浏览器打开专门的网页才能查看完整文档,体验比较割裂且不方便。

插件使用指南

Step 1:右键任意文件/文件夹,点击“What's this?”

image.png

Step 2:编辑说明文档后保存

image.png

Step3:查看文件/文件夹说明文档

image.png

插件需求/Bug反馈

  1. 直接留言
  2. 邮箱联系 1344583166@qq.com
  3. 微信联系 13104734818