SuperAPI AI Directory

readme-craft

Writing & research

View repository

Updated 10-15 10:49

About this skill

README method

Load project-protocol:project-protocol and the project-knowledge method for run ownership, input preparation and authorized application. Receive the scope, snapshot, existing README, reader, mode, output path and authorizations.

Audit-only

Read the README, manifests, license, configured scripts, pertinent entry points, public interfaces, assets and CI. Apply references/audit-checklist.md to every claim, count, link, badge and command in scope. Compare implemented features with approved intent rather than making the current code the product requirement. Report evidence locators, status, preserved voice, wrong claims, structural recommendations, uncovered surfaces and unavailable checks. Write only the owned run report. Audit-only does not update README, badges, links, docs or ignore rules.

Create or maintain

Prefer the existing README and its intentional style. Read references/layout-techniques.md only for relevant structure patterns: a project may need a plain introduction, install instructions and one working example, without promotional claims, images, badges or community links. Never invent user quotes, performance claims, download counts, package names or missing metadata. Ask for a missing material choice only when needed; optional decoration can be omitted. Follow the planned file and scope; full restructure requires an authorized scope that permits it, rather than a new automatic approval ritual.

Use the project's verified scripts and install conventions. Distinguish a copied command from one actually exercised. Correct accepted findings through the project-knowledge apply-method, preserving facts, author voice and inbound links. For a requested prose pass, load text-humanizer:anti-ai-writing-patterns and dispatch text-humanizer:text-humanizer in the docs register. Record new or retained gaps and checks in the same run; do not reproduce a session log in README.