agentleFS
jqaisystemsjqaisystems/jqai-ai-skills/skills/case-study-writer/SKILL.md

case-study-writer

Skill3 starsChanged 6 months agoMITView on GitHub

Write public-safe case studies from private projects, automations, agent workflows, internal tools, demos, or client-facing systems. Use when the user asks to turn project work into a case study, create client proof, write a sanitized GitHub case study, summarize an internal system publicly, document an automation without sharing source code, or explain a workflow while removing credentials, raw prompts, logs, databases, client data, local paths, and private implementation details.

8 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 8 edited versions we read keep these.

  • 7

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill to turn private project work into public-safe proof: concise case studies that explain the problem, workflow, outcome, and …

    line 10
  2. Very specific:

    Read references/case-study-template.md and use its section order unless the destination already has a stronger house style.

    line 15
  3. Very specific:

    Read references/safety-boundary-examples.md before writing the opening boundary note and final Safety Boundary section.

    line 16
  4. Distinctive:

    Use these sections by default:

    line 29
  5. Distinctive:

    Keep the case study short enough to scan quickly.

    line 41
  6. Distinctive:

    Never include source code, private prompts, API keys, credentials, databases, logs, exports, client messages, account identifiers, local …

    line 45
  7. Distinctive:

    Do not name clients, prospects, internal codenames, domains, or people unless the user confirms they are approved for public use.

    line 46
  8. Distinctive:

    Use broad stack categories such as Python, SQLite, browser automation, queue dashboard, or LLM API instead of exact private architecture …

    line 47
  9. Very specific:

    If the user provides risky source material, return BLOCK with removal instructions before writing the publishable draft.

    line 49
  10. Distinctive:

    If the user asks you to edit files, write the draft into the requested location or a sanitized staging folder, then recommend running a …

    line 60

“Common” is measured: kept by at least 6 in 10 of the 8 edited versions of this file we could read. “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

Case Study Writer

Overview

Use this skill to turn private project work into public-safe proof: concise case studies that explain the problem, workflow, outcome, and adaptation value without exposing source code, credentials, raw prompts, logs, databases, client data, or private implementation details.

Workflow

  1. Clarify the public artifact target: GitHub case study, website system page, portfolio note, demo companion, or README section.
  2. Read references/case-study-template.md and use its section order unless the destination already has a stronger house style.
  3. Read references/safety-boundary-examples.md before writing the opening boundary note and final Safety Boundary section.
  4. Extract only public-safe facts:
    • Problem the system solves.
    • What the system does at workflow level.
    • Human review and approval points.
    • General stack categories when useful.
    • Outcome stated qualitatively or with approved aggregate numbers.
    • What a similar client could adapt.
  5. Rewrite private details into generic, reusable language. Do not copy raw notes, prompts, logs, exports, database rows, or source code.
  6. Produce the case study in Markdown and include a short safety verdict: BLOCK, REVIEW, or READY.

Case Study Shape

Use these sections by default:

  • Title
  • Boundary note
  • Public page or demo links, if already approved and live
  • Problem
  • What The System Does
  • Workflow
  • Outcome
  • What Can Be Adapted For Clients
  • Safety Boundary

Keep the case study short enough to scan quickly. Prefer six to eight workflow steps and three to five client-adaptation bullets.

Safety Rules

  • Never include source code, private prompts, API keys, credentials, databases, logs, exports, client messages, account identifiers, local paths, or screenshots with private UI.
  • Do not name clients, prospects, internal codenames, domains, or people unless the user confirms they are approved for public use.
  • Use broad stack categories such as Python, SQLite, browser automation, queue dashboard, or LLM API instead of exact private architecture when details are not needed.
  • Mention human approval explicitly when the system drafts, scores, publishes, sends, spends, or changes a system of record.
  • If the user provides risky source material, return BLOCK with removal instructions before writing the publishable draft.

Output Format

Return:

  1. Safety verdict: BLOCK, REVIEW, or READY.
  2. Short note on what was excluded or generalized.
  3. The Markdown case study.
  4. Remaining checks before publication.

If the user asks you to edit files, write the draft into the requested location or a sanitized staging folder, then recommend running a public-safety scan before commit.

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.