SKILLEMALL.ai
GitHub ↗ RU Sign in

AC readme

When the user wants to create or update a README.md file for a project. Also use when the user says 'write readme,' 'create readme,' 'document this project,' 'project documentation,' or asks for help with README.md. This skill creates absurdly thorough documentation covering local setup, architecture, and deployment.

modbender/skill-library-mcp Agent Skills author: modbender MIT 1 file body ≈ 4 781 tokens Open the sourcegithub.com↗ analyzed 2 d ago

When the user wants to create or update a README.md file for a project. Also use when the user says 'write readme,' 'create readme,' 'document this project,'…

As a process C 58/100 · Has gaps — weak spots: failures and branches, running it twice, progress reporting

GeneratorDockerPostgreSQLGitHubKubernetesWriting and documentsInfrastructuretype and topics are labelled automatically from the skill text
Runs in: OpenClaw Claude / Claude Code ChatGPT / Codex Gemini CLI Cursor GitHub Copilot / VS Code Qwen Code Kimi Code CLI Z.ai (GLM) DeepSeek (Deep Code) Mistral Vibe LangChain (deepagents) Goose OpenCode
JSON
Technical rating
A
93/100
safety, quality, tests
Safety 60%
99
Quality 40%
83
Run on models
none yet
Process rating
C
58/100
Has gaps
Failures and branches w 10
0
Progress reporting w 2
0
Running it twice w 4
30
the three weakest of ten parameters · all ten

How to improve

    For the model run — optional
    • Your own cases (evals/evals.json, 4–6 real requests with expected answers): the full check would then run those instead of a model-drafted suite.
    • A spec.yaml with trigger phrases and assertions — a behaviour contract for CI; `skilltest init` writes a template.

    Guard findings · 1

    ✓ No critical or high findings

    Medium and low: 1
    • low Exfiltration read-dotenv SKILL.md:183
      Reads a .env file
      cp .env.example .env

    Files scanned: 1. Evidence is masked. Grey chips explain why severity was lowered.

    Against the Agent Skills spec

    • note frontmatter-key unknown frontmatter key "source"
    • note frontmatter-key unknown frontmatter key "risk"

    Process rating: all ten parameters 58/100

    • 0Failures and branches. Linear process with no failure handling
    • 0Progress reporting. Says nothing while it works
    • 30Running it twice. 12 mutating operations with no state check
    • 60Tools and files. Uses tools (bash) that frontmatter does not declare
    • 60Steps. 56 steps, 7 vague phrases
    • 60Result and completion. Output format stated, no completion criterion
    • 70When it triggers. States when to use, but not when not to
    • 70Inputs and preconditions. Inputs and preconditions are listed
    • 70Execution cost. Instruction body is 4781 tokens
    • 100Consistency. Name and required fields are in place

    Everything here is measured from the skill text rather than judged by a model, so the numbers are checkable. A parameter weighs more when it is a more common reason for the process to stall.

    Quality signals

    • +5Description has no quoted example phrases that should trigger the skill
    • +4Description does not say when NOT to use the skill (false activations)
    • -2localhost URLs: will not work for another user
    • +1No license
    • +2Single-language instructions
    • +3Description length 318: enough signal without eating the budget
    • +4Structure: 22 headings
    • +3Step-by-step instructions: 56 items
    • +3Output format is stated explicitly
    • +4Has examples (10 code blocks)

    Quality base 70; lint remarks subtract, signals add up to 100. Result: 83.