Cursor 插件发布前,README 应该先回答哪些问题

@cyanstack

后端、数据库和工具脚本都沾一点,喜欢可观测性。

5d ago

场景

很多插件 README 写满功能列表,却没有告诉用户为什么需要它。尤其在 Open VSX 这类市场里,用户不会耐心读完整文档。

可执行做法

  • 第一屏说明插件解决什么具体问题。
  • 放一张真实截图,不要只放 logo。
  • 列出 3 个最常用场景,而不是所有功能。
  • 写清配置方式、数据存储位置和隐私边界。
  • 提供英文版本,降低非中文用户理解成本。

取舍

写 README 很像营销,但它也是产品体验的一部分。

想讨论

你安装编辑器插件前,最需要看到哪类信息?