Skill README Generator
Paste the following prompt into your AI chat to install this skill:
Please install @user_8c37677c/create-skill-readme according to https://skillhub.cn/install/skillhub.md.
About this skill
What problem it solves
When a skill already has SKILL.md, the missing piece is usually a user-facing README that explains value, usage, and required credentials without leaking internal agent mechanics. This skill keeps README generation inside a product-introduction frame, so the output does not become a script manual, dependency list, or inconsistent translation patch.
How it works
It follows a fixed source order: the current instruction, readme_formate.md, the target SKILL.md, then _meta.json and references/. By default it writes README.md and can generate README.en.md as a full structural translation of the finalized Chinese version.
- It detects language mode, so “add key only” requests do not rewrite unrelated sections;
- It includes only sections supported by the material, such as introduction, core features, usage guide, and scenarios;
- It inserts the fixed API Key security block when key usage is required;
- It replaces implementation terms with user-facing language while preserving technical clarity.
Boundaries
It does not add installation commands, dependency setup, internal fields, FAQ, or changelog unless explicitly requested or supported by the source material. Claims must be traceable to the current skill, and the English version should remain aligned with the final Chinese structure.
Use Cases
- Add a user-facing Chinese README after finalizing `SKILL.md`, while avoiding script-manual style.
- Generate a `README.en.md` with the same structure when a Chinese README already exists.
- Insert the fixed API Key security section before publishing a key-required skill without rewriting other sections.
- Select supported sections from skill materials and references to produce a product-introduction style README.
Best For
- Engineers maintaining skill repos who need to turn `SKILL.md` into user-readable documentation.
- Skill authors publishing tooling skills who need consistent Chinese and English READMEs plus key notes.
- Developers shipping skills to end users who need to keep internal agent mechanics out of docs.
- Ops engineers reviewing skill listings who need README claims traceable to source materials.
Related Skills
Automatically indexes Gradle-cached AAR/JAR dependency classes and returns library coordinates, versions, and public APIs by fully qualified name, using only the Python standard library.
Codifies AMT and YourMT3 training conventions, script patterns, hyperparameters, precision, checkpoints, and NaN safeguards.
Retrieve relevant chunks from a customer-managed PKM dataset by dataset_id and return concise, source-annotated answers.
Convert PRDs, user stories, or functional specs into prioritized test-point checklists covering functional, business-rule, boundary, exception, and non-functional dimensions.