目前没有能全自动写出高质量项目描述的VSCode插件；所有插件仅生成骨架，Installation、Usage、Contributing三部分仍需手动补充。
直接说结论：目前没有能“全自动写出高质量项目描述”的 VSCode 插件；所有插件都只生成骨架（比如目录树、文件列表、基础字段），真正让别人看懂项目，还得你亲手补三块内容——Installation、Usage、Contributing。
readme-tree 插件：最省事的目录树生成器，但只干一件事
它不写介绍、不编示例、不猜功能，只做一件事：在光标处插入当前项目的文件树结构。输出是纯 Markdown，天然支持折叠（用 <details><summary>），默认跳过 node_modules、.git、out 等目录，不用配。
- 触发方式：打开
README.md→ 光标定位 →Ctrl+Shift+P→ 输入Readme: Insert Tree回车 - 生成结果干净，但顶部空着——它连
## Features都不加，更不会读package.json - 如果你用
vsce打包过插件，它的核心逻辑（fs.readdirSync+ 递归拼接）可以直接抄进脚本复用
file-desc 插件：给单个文件/目录加描述，但得自己维护 JSON
它不生成 README.md，而是右键文件或文件夹 → “编辑描述” → 写一句话说明用途 → 存到项目根目录的 DirectoryV2.json 里。这个 JSON 文件可被插件自带的自定义编辑器预览。
- 适合结构复杂、成员频繁变动的老项目，用来快速唤醒记忆：“哦，这个
utils/transform.ts是处理 Excel 导入格式的” - 目前不支持图片文件预览，右键打开会报错；JSON 结构扁平，没嵌套层级，靠人工维护一致性
- 插件尚未上架 VS Code Marketplace，需手动下载
.vsix安装，activationEvents配置里写了onCommand:vsplugin.fileDescJson和onCustomEditor:catCustoms.catScratch
别漏掉 package.json 的 description 字段，否则 README 开头就是空白
readme-tree 和多数模板类插件会尝试读取 package.json 的 name 和 description 填到 README 顶部。如果字段为空或缺失，生成的文档第一行就塌了，显得非常不专业。
- 检查命令：
cat package.json | grep description - 补一句实在话就行，比如：
"description": "CLI tool to sync local files with S3, supports dry-run and checksum validation" - 顺手填上
repository和author，GitHub 页面会自动展示，比插件生成的链接更可信
真正容易被忽略的是：目录树再漂亮，如果 .gitignore 里漏了 DirectoryV2.json 或生成的临时文档，下次 git commit 就可能误提交一堆描述垃圾——得手动加一行。
