agentmods.dev

blog.write_tutorial_readme

A writing guide for making a hands-on technical tutorial about one tool, technique, or concept. It is aimed at software engineers with general to intermediate programming knowledge and is designed for a 10–15-minute read.

In plain words
What is it for?
Use it to write tutorials with prerequisites, installation commands, setup checks, core concepts, documentation links, and a focused example.
Why use it?
It gives tutorials a practical structure so readers can understand when a tool is useful, set it up, and apply its main ideas without reading an overly broad survey.

Skill for Claude CodeCodex

145 2d ago C scan 22 tokens original Apache-2.0
View the source file causify-ai/helpers
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/causify-ai/helpers/blog.write_tutorial_readme
Any agent
npx skills add causify-ai/helpers --skill blog.write_tutorial_readme
Clone the repo
git clone --depth 1 https://github.com/causify-ai/helpers

Made for: Claude Code, Codex.

Per session 22 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 677 The whole file, excluding the scripts and references it only reads on demand.
Security scan C 2 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00022 $0.00677
Opus 5 $0.00011 $0.00338
Sonnet 5 $0.00004 $0.00135
Haiku 4.5 $0.00002 $0.00068

Measured 2d ago against content hash e900370eb7cc, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade C, and why

blog.write_tutorial_readme scanned grade C with 2 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Downloads and executes remote codehighSupply chain

curl | sh runs whatever the server returns today, which is not necessarily what it returned when this was reviewed.

> curl -LsSf https://astral.sh/uv/install.sh | sh

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

> curl -LsSf https://astral.sh/uv/install.sh | sh
.claude/skills/blog.write_tutorial_readme/SKILL.md · 93 lines

How it starts

The opening of the file, as written. The whole thing — 93 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Goal

  • Write clear, hands-on tutorials that help engineers quickly learn a new tool, technique, or concept
  • Tutorials should be practical and immediately applicable, not theoretical surveys

Audience

  • Target: Software engineers and technical practitioners
  • Skill level: General to intermediate (some programming knowledge assumed)
  • Goal: Enable readers to use the tool/technique effectively after reading

Tutorial Structure

  • Follow this outline:

    1. Introduction (1-2 paragraphs)

      • What is this tool/concept?
      • Why should engineers care? (What problem does it solve?)
      • When to use it (not just "always")
      • What are other tools that solve similar problems
      • Links to official docs
        • Installation
        • Documentation
        • Tutorial

    2. Prerequisites (if any)

      • Required knowledge or tools

    3. Installation/Setup (if applicable)

      • Clear, copy-paste ready commands
      • Verify installation with a simple test

    4. Core Concepts (1-2 paragraphs)

      • Explain 2-3 key ideas

Guidelines

Length

  • Target: 10-15 minutes reading time (roughly 1500-2500 words)
  • Avoid: Overly long tutorials that cover everything; focus on the 80% use case

Template

  • Use website/docs/blog/posts/draft.blog_template.md as template

Code Examples

  • Use copy-paste ready code blocks with bash or language-specific syntax highlighting
  • Include expected output so readers know it worked
  • For shell commands, show the prompt style, e.g.,
    • On macOS and Linux using the official installer: 
      > curl -LsSf https://astral.sh/uv/install.sh | sh

Platform Coverage

  • Focus on macOS and Linux instructions

Tone & Voice

  • Direct and practical ("use this when..." not "one might consider...")
  • Active voice, short sentences
  • Assume readers are busy engineers
  • Don't be overly casual

Visuals

  • Include diagrams only if they clarify workflow or architecture
  • Use simple diagrams using mermaid, graphviz, or reference external images if needed
  • Don't over-decorate

Read the full file on GitHub · 93 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 93 lines · 22 tokens per session scan C e900370eb7cc

Subscribe to this mod's changes

blog.write_tutorial_readme is a skill published in the GitHub repository causify-ai/helpers (145 stars, last pushed 2d ago), licensed Apache-2.0. It adds 22 tokens to every session and 677 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it C with 2 findings (downloads and executes remote code, makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Learning and teachingWriting and docs
Related

Other skills, from other repositories

book-mirror

Take any book (EPUB/PDF), produce a personalized chapter-by-chapter analysis. Each chapter is preserved in detail (The Chapter) and mirrored back to the reader's actual life (The Mirror) using brain context. The mirror observes and resonates — a friend pointing out parallels, NOT a consultant rearranging the reader's…

garrytan/gbrain · 138 tokens

ljg-learn

Deep concept anatomist that deconstructs any concept through 8 exploration dimensions (history, dialectics, phenomenology, linguistics, formalization, existentialism, aesthetics, meta-philosophy) and compresses insights into an epiphany. Use when user asks to explain, dissect, or deeply understand a concept, term, or…

lijigang/ljg-skills · 113 tokens

eli5

Explain research, papers, or technical ideas in plain English with minimal jargon, concrete analogies, and clear takeaways. Use when the user says "ELI5 this", asks for a simple explanation of a paper or research result, wants jargon removed, or asks what something technically dense actually means.

companion-inc/feynman · 63 tokens

deck-course-module

暖纸背景 + Playfair, 左侧学习目标常驻, 含 MCQ 自测页.

nexu-io/html-anything · 25 tokens

pedagogy-review

Holistic pedagogical review of a lecture deck (.qmd or .tex). Checks narrative arc, prerequisite assumptions, worked examples, notation clarity, and deck-level pacing. Use when user says "pedagogy review", "does this teach well?", "is the flow right?", "will students follow?", "review the narrative", or before…

pedrohcgs/claude-code-my-workflow · 90 tokens

master-yinguang

Use when user asks about 印光大师, 净土, 念佛, 持名念佛, 十念法, 摄耳谛听, 老实念佛, 信愿行, 带业往生, 仗佛慈力, 自力他力, 竖出横超, 往生, 极乐, 阿弥陀佛, 净土三经, 敦伦尽分, 闲邪存诚, 因果报应, 文钞, 一函遍复, or wants teaching in 印光大师 Yinguang's voice. Triggers include "印光"、"文钞"、"老实念佛"、"信愿行"、"带业往生"、"仗佛慈力"、"横超竖出"、"都摄六根"、"净念相继"、"敦伦尽分"、"闲邪存诚"、"因果"、"十念法"、"摄耳谛听"、"一函遍复"、"净土三经"、"往生" — invoke…

xr843/Master-skill · 274 tokens