Back to Skills

technical-writing

verified

Writes technical blog posts about features being built. Triggers when user asks to write about development progress, implementations, or project updates.

View on GitHub

Marketplace

richtabor-skills

richtabor/agent-skills

Plugin

development

Repository

richtabor/agent-skills
35stars

skills/technical-writing/SKILL.md

Last Verified

January 21, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/richtabor/agent-skills/blob/main/skills/technical-writing/SKILL.md -a claude-code --skill technical-writing

Installation paths:

Claude
.claude/skills/technical-writing/
Powered by add-skill CLI

Instructions

# Technical Writing Skill

## Overview

Create technical blog posts about features you're building. This skill analyzes your codebase to understand implementations, then structures clear, engaging content that balances technical detail with readability while avoiding AI-sounding language.

## Process

### Phase 1: Research and Planning

**1.1 Load Writing Guides (REQUIRED - Load First)**

Before any other work, read BOTH reference files:

1. **Writing Rules** (`references/anti-patterns.md`) - Comprehensive lists of AI-sounding words, phrases, and patterns to avoid. This is the foundation - what NOT to sound like.

2. **Style Guide** (`references/style-guide.md`) - Personal writing voice, tone, structure, and signature moves. This is the voice layer - what TO sound like.

**PRIORITY RULE**: When guides conflict, `references/anti-patterns.md` wins. Avoiding AI patterns always takes precedence over stylistic choices.

**1.2 Understand What Was Built**

Investigate the codebase to understand the feature:

- Ask which feature or changes they want to write about
- Use git to check recent commits if relevant (skip if not a git repo): `git log --oneline -10`
- Read relevant code files to understand implementation
- Identify key technical decisions, architecture, and interesting details
- Note any challenges solved or clever solutions

**1.3 Plan the Structure**

Plan what to cover in the post. Use these as a guide, not a rigid template:

- **Opening**: Start with an engaging hook or context for what you built
- **Overview**: Brief explanation of the feature (2-3 sentences)
- **Problem/Value**: Why this matters or what problem it solves
- **Technical Details**: How it works with code snippets
  - Key implementation details
  - Interesting technical decisions
  - Architecture or design patterns used
- **Challenges**: What was tricky and how you solved it (if relevant)
- **Future**: Next steps or related features (if relevant)
- **Tech Stack**: Technologies used (can be woven 

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
5225 chars