A README skill that deletes claims it cannot source

说明与用途

该技能从 README 中删除未验证的声明，用可验证的事实替换，并标记未验证的功能，从而提高文档准确性。

问题

README files often contain unsourced claims such as install commands for non‑existent packages, configuration keys that the code does not use, or roadmap features described as if already released.

结果

The skill eliminates unsourced claims, replaces them with verifiable information, and flags unverified features, producing a more accurate and user‑friendly README.

工作流

• 1. Build a fact map from the repository (package manifests, entry points, example scripts, tests, CI config, existing docs).
• 2. Generate README content only from supported facts.
• 3. Remove any claim that cannot be sourced rather than rewording it.
• 4. Record unverified items so they appear as limitations.
• 5. Apply a structure template that matches the project’s domain (e.g., CLI, desktop app, script) based on a study of 200 high‑star repositories.
• 6. Output the rewritten README.
• 7. Optionally run the skill via the CLI: npx skills add chromoany/readme-atlas and then Use $readme-atlas to rewrite the README.

证据

Before writing a sentence, the skill builds a fact map from the repository: package manifests, entry points, example scripts, tests, CI config, and any existing docs.

来源

When something cannot be sourced, the claim is removed rather than reworded.

来源

The 200-repository study is about structure, not quality. It tells you whether a README's shape matches what readers of that kind of project expect, not whether the project is worth using.

来源

The skill is plain Markdown — instructions plus reference files loaded on demand. No runtime, no API key.

来源