pragmatic-writing

Solid

This skill should be used when writing technical content in the style of Hunt/Thomas (The Pragmatic Programmer) and Joel Spolsky (Joel on Software). It applies when creating technical essays, documentation, tutorials, or explanatory content that needs to be clear, engaging, and actionable.

AI & Automation 113 stars 20 forks Updated 1 months ago MIT

Install

View on GitHub

Quality Score: 82/100

Stars 20%
68
Recency 20%
75
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Pragmatic Writing Skill Writing style modeled on the masters of technical communication: Andy Hunt, Dave Thomas (The Pragmatic Programmer), and Joel Spolsky (Joel on Software). This skill transforms technical content into engaging, memorable prose. ## When to Use This Skill This skill applies when: - Creating technical blog posts, essays, or articles - Writing documentation that needs personality - Explaining complex concepts to developers - Crafting tutorials or how-to guides - Writing "lessons learned" or postmortem content - Any technical writing that should be read, not just referenced ## Core Philosophy > "The difference between 'almost right' and 'right' is the difference between the lightning bug and the lightning." — Mark Twain (quoted by Pragmatic Programmers) Technical writing doesn't have to be dry. The best technical writers make complex ideas feel obvious, use concrete examples before abstract theory, and treat the reader as a smart colleague. ## The 10 Core Techniques Reference the complete technique guide at [techniques.md](./references/techniques.md). ### 1. Concrete Before Abstract **Always** start with a concrete example, then extract the principle. ``` ❌ "Dependency injection is a design pattern where dependencies are passed to objects rather than created by them." ✅ "Imagine your class needs a database connection. You could create it yourself: def initialize @db = Database.new("localhost:5432") end But now your cla...

Details

Author
robertguss
Repository
robertguss/claude-code-toolkit
Created
8 months ago
Last Updated
1 months ago
Language
Shell
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

Code & Development Listed

technical-writer

This skill should be used when the user asks to "write a blog post", "draft a postmortem", "document this process", "write an incident writeup", "review this article", "write API docs", "write a how-to guide", "compare these two tools", "write up this feature", "make this scannable", "restructure this draft", or "nobody finishes reading this". Produces technical writing that is problem-first, concrete, and humble: real numbers instead of adjectives, real incidents instead of invented scenarios, and structure built for how people actually read on a screen. Applies to public blogs, internal team docs, code reviews, and personal knowledge vaults. Supports a public-facing mode (more scaffolding) and an internal mode (tighter), and produces both when asked.

7 Updated 1 weeks ago
widnyana
AI & Automation Listed

technical-writing

Use when writing or revising user-facing prose -- READMEs, changelogs, guides, adapter docs, or release notes. Audience-first structure with a quickstart before theory, every claim verified against the repo, and no invented benchmarks or features.

1 Updated today
xsefirosus
AI & Automation Listed

core-technical-writing

Doctrine for authoring clear, precise technical documentation in {{PROJECT_NAME}}. Covers hard rules for structure, voice, and vocabulary; format conventions by doc type (README, ADR, plan, CHANGELOG, API reference, runbook); anti-patterns that degrade clarity; and WRONG/CORRECT examples across doc types. Use when authoring or reviewing any documentation artifact — from a one-sentence inline comment to a multi-section ADR or a public API reference.

2 Updated today
Canhada-Labs