把项目信息整理成 README

写清能做什么，
也写清不做什么。

把项目笔记、功能列表与零散说明整理成一份 README：定位、安装、用法、边界与贡献方式。不编造能力、依赖、命令、许可证、性能数据与兼容性，缺失的部分写占位并列入待核实。

能力不虚构缺失写占位边界必写

审阅 README 结果

结果会显示在这里

系统将先写定位与边界，再整理安装与用法，缺失的部分留占位，并列出所有需要你确认的事实。

示例结果

你会拿到的输出，长这样。

下面是对上方演示原文的完整输出示例：完整度评分、逐条整理说明、被写成占位与待核实的部分及原因，以及整理后的 README。示例为演示用途，不是客户案例。

示例

README 结果（示例）

完整度评分88/100

+50

把未说明的定位写成待补充

原文只说“帮团队整理文档”。定位一节保留描述，并明确写出目标用户与典型场景仍需补充。

把安装与用法改为占位

“装一下依赖就能跑”不构成安装说明。改为占位并列出需要补充的包管理器、命令与环境要求。

把无数据的宣传语降级

“支持各种格式”“速度也快”没有清单与数据支撑，分别进入支持范围与性能两节的待核实项。

整理后的 README

# 项目名称 [待填写]

## 这是什么
为团队整理文档的工具。具体解决的问题与适用对象待补充。

TODO：原文未说明目标用户与典型使用场景

## 安装
[待填写：安装步骤]

TODO：原文仅提到“装一下依赖就能跑”，未给出包管理器、命令与环境要求

## 用法
[待填写：基础用法示例]

TODO：原文无命令、配置或调用示例

## 支持范围
待核实：原文称“支持各种格式”，未列出具体格式清单

## 边界
- 待补充：当前不支持的能力与已知限制

## 性能
待核实：原文称“速度也快”，未提供任何测试数据

## 许可证
未指定：原文未提及许可证，需由维护者确认

## 贡献方式
欢迎提交 PR。

TODO：需补充贡献流程、代码规范与评审要求

整理做什么

README 是承诺，不是广告。

先说解决什么问题

第一屏回答“这是什么、给谁用”。读者不会翻到第三段去找定位。

安装命令不能猜

一条看起来合理但跑不通的命令，比明写着待补充更糟。

边界要单独成节

不支持什么、还在做什么，写清楚反而更容易被信任和采用。

为什么值得做

README 里写错一行，用户要花一小时。

跑不通的安装命令最劝退

新用户第一步就失败，多数人不会再来第二次，也不会告诉你哪里错了。

编出来的能力会被当成需求

写进去的功能用户会真的去找，找不到就认为是 bug，issue 就来了。

许可证不能靠猜

许可证影响别人能不能用。没写清就写未指定，让维护者自己决定。

说明：README 的常见写法是先给出定位与适用对象，再给安装与用法，最后说明边界与贡献方式。不同社区对章节顺序与详细程度有各自习惯。本站只做文档整理，不读取仓库代码，也不提供法律意见或兼容性保证。

整理演示

同一段项目介绍，整理后的样子。

整理前

我们做了个项目，能帮团队整理文档，很好用，速度也快，支持各种格式。装一下依赖就能跑，具体怎么装看情况。大家有兴趣可以一起参与，欢迎提 PR。

整理后

# 项目名称 [待填写]

## 这是什么
为团队整理文档的工具。具体解决的问题与适用对象待补充。

TODO：原文未说明目标用户与典型使用场景

## 安装
[待填写：安装步骤]

TODO：原文仅提到“装一下依赖就能跑”，未给出包管理器、命令与环境要求

## 用法
[待填写：基础用法示例]

TODO：原文无命令、配置或调用示例

## 支持范围
待核实：原文称“支持各种格式”，未列出具体格式清单

## 边界
- 待补充：当前不支持的能力与已知限制

## 性能
待核实：原文称“速度也快”，未提供任何测试数据

## 许可证
未指定：原文未提及许可证，需由维护者确认

## 贡献方式
欢迎提交 PR。

TODO：需补充贡献流程、代码规范与评审要求

演示样例：把“支持各种格式”“速度也快”改成待核实项，把缺失的安装与用法写成占位而不是编命令，许可证写未指定。在工作台提交你的项目信息即可得到针对你的版本（需登录，每次消耗 1 次额度）。

为什么可以放心

我们把“不编能力”写进了产品原则。

没写的功能不会出现在 README 里

素材里没有的能力、依赖与命令一律写成占位，不会为了让文档看起来完整而补充。

许可证不猜

没提许可证就写未指定，并列入待核实。许可证影响别人能不能用，只能由维护者决定。

性能与兼容性不写数字

没有实测数据的速度、兼容与支持声明一律不写，改为需要确认的事项。

正文不留存

提交的内容仅用于本次 AI 处理，本站不主动保存正文；详见隐私政策。

常见问题

付费前，你可能想问。

会帮我补上缺失的安装命令吗？

不会。安装命令、依赖与环境要求写成占位并列入待核实。一条跑不通的命令比明写着待补充更有害。

素材里没提许可证怎么办？

写“未指定”并列入待核实。许可证影响他人能否使用，只能由维护者确认，我们不替你选。

“很快”“支持很多格式”这类描述怎么处理？

不写入正文。改成待核实项，说明需要提供具体格式清单或实测数据后才能写进 README。

一次整理消耗什么？耗时多久？

一次整理消耗 1 次额度，通常十几秒完成，输出 README、整理说明与待核实清单。

额度会过期吗？

不会。额度永不过期，本次没用完的部分会自动累积到下一次，不会清零。

支持批量处理或 API 吗？

目前每次处理一篇内容，不提供批量上传或 API，额度按次消耗。如你有大量自动化需求，请先邮件说明场景。

我的内容会被保存吗？

不会主动保存。正文仅用于本次 AI 处理，详见隐私政策。

适合哪些内容？

新项目的第一版 README、内部工具对外开源前的整理稿、只有功能列表没有文档的仓库、会议上的口头项目介绍——任何需要变成正式 README 的项目信息。

简单透明的价格

先验证价值，再决定是否升级。

Starter

$9/ 月

适合发布频率较低的轻量使用者。

50 次优化额度，每月续费发放
完整 GEO 分析
中英文输出
Markdown 导出

Pro

Advanced

$79/ 月

含最高月度额度，适合最高频的深度使用者。

1,000 次优化额度，每月续费发放
完整 GEO 分析
中英文输出
Markdown 导出

额度永不过期：未用完的额度会累积到下一次，不会清零。额度仅在当前站点有效，不与其他站点通用。

标价为美元基准价；最终币种、税费与折扣由 Paddle 按结账所在地确定。