agentleFS
Sign inStart free
e-dule-dul/opencl-lab/.claude/skills/readme-creation/SKILL.md

readme-creation

Skill0 starsChanged 8 months agoMITView on GitHub

Procedure for writing educational, user-facing Module READMEs.

2 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions2 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 2

    1. KemingHe/common-devx★ 10same name
    2. nnennandukwe/skills★ 4same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository11 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

7 rules. About 0 are common, 3 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Read Existing Readme: Read file [ModuleFolder]/[Module Name].md if it's available.

    line 11
  2. Very specific:

    Fetch Context: Read 00-executive-summary.md to understand the overarching goal of the track/module.

    line 12
  3. Very specific:

    Fetch Template: Read the workflow/templates/module_doc_template.md file from the workspace root.

    line 13
  4. Distinctive:

    Write 1-2 sentences explaining what the module teaches and why it matters.

    line 15
  5. Distinctive:

    Just-in-Time Learning: Only introduce theory (e.g., Memory Coalescing, Thread Divergence) *after* the user has run the code or encountered …

    line 19
  6. Distinctive:

    Add a small "Mini-challenge" for the user to modify the code and test their understanding.

    line 20
  7. Very specific:

    Save: Write the output to [ModuleFolder]/[Module Name].md.

    line 21

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

README Creation Skill

You are executing the Documentation/Educational phase.

Instructions

  1. Read Existing Readme: Read file [ModuleFolder]/[Module Name].md if it's available. See 02_Projects/A_Multimedia/Multimedia.md or 99_Toolbox/CoalescedAccess/CoalescedAccess.md for samples.
  2. Fetch Context: Read 00-executive-summary.md to understand the overarching goal of the track/module.
  3. Fetch Template: Read the workflow/templates/module_doc_template.md file from the workspace root.
  4. Draft the README:
    • Write 1-2 sentences explaining what the module teaches and why it matters.
    • Define exact terminal commands (bash cd 01FolderName, cmake -B build, cmake --build build) for the user to run.
    • Define the expected visual or terminal output so the user can verify success.
  5. Pedagogy Rules:
    • Just-in-Time Learning: Only introduce theory (e.g., Memory Coalescing, Thread Divergence) after the user has run the code or encountered the problem.
    • Add a small "Mini-challenge" for the user to modify the code and test their understanding.
  6. Save: Write the output to [ModuleFolder]/[Module Name].md. See 02_Projects/A_Multimedia/Multimedia.md or 99_Toolbox/CoalescedAccess/CoalescedAccess.md for samples.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free