technical-writer

Write and validate technical documentation following structured content models and style guides.

Updated Aug 17, 2026
One-click install
npx skills add https://github.com/prabaljainn/my-claude-code-setup --skill technical-writer-prabaljainn
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/prabaljainn/my-claude-code-setup/tree/main/claude/skills/technical-writer
Command: npx skills add https://github.com/prabaljainn/my-claude-code-setup --skill technical-writer-prabaljainn

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve? Writing consistent, accurate technical documentation is hard: READMEs, API docs, tutorials, and release notes each follow different conventions, and teams often produce unclear, poorly structured content. This Skill applies industry-standard content models and style rules so documentation is clear, accessible, and task-focused. ## Core Features & Use Cases - Structured Content Types: Guides creation of conceptual, referential, procedural, troubleshooting, quickstart, tutorial, and release notes content, each with its own rules for titles, intros, and structure. - Style Guide Enforcement: Applies rules for sentence case headings, active voice, code formatting, descriptive links, alert usage, and accessibility (alt text, heading hierarchy). - Markdown Validation: Includes a script that checks markdown files for skipped heading levels, missing code block language tags, unclosed code fences, and non-descriptive link text. - Use Case: Ask it to draft a README for a new project, write API reference docs with parameter tables, or review an existing docs/ directory for clarity and structural issues. ## Quick Start Ask the assistant to write a README for your project or review the markdown files in your docs folder for style and structure issues.

Frequently Asked Questions about technical-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a good README file for my project?▼

Start with a sentence-case title and a 1-2 sentence intro explaining what the project does. Add prerequisites, numbered setup steps with one action each, and a next steps section. Keep language active and direct, and verify all code examples run as documented.

How to structure API documentation with parameter tables?▼

Use referential content structure with tables for parameters showing names, types, and descriptions. Organize alphabetically or logically, include runnable code examples with expected output, and use backticks for code elements and ALL-CAPS for placeholders like YOUR_API_KEY.

What are the rules for writing step-by-step procedures?▼

Start each step with an imperative verb, include only one action per step, and use numbered lists. Add a prerequisites section upfront, keep total steps under 10, and order procedures as enabling, using, managing, disabling, then destructive tasks.

Can this validate markdown files for common documentation errors?▼

Yes, the included validate_markdown.py script checks markdown files for skipped heading levels, title-case headings, missing code block language tags, unclosed code fences, and non-descriptive link text like click here. Run it on a single file or an entire directory.

When should I not use technical documentation conventions?▼

These conventions do not apply to creative writing, marketing copy, academic papers, code comments or docstrings, or informal internal notes. The skill targets user-facing technical content like guides, references, and release notes only.