technical-writer

Score documentation clarity, completeness, actionability, and structure with prioritized fixes.

Updated Apr 15, 2026
One-click install
npx skills add https://github.com/ToanPV90/dotfiles --skill technical-writer-toanpv90
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/ToanPV90/dotfiles/tree/main/claude/.claude/skills/technical-writer
Command: npx skills add https://github.com/ToanPV90/dotfiles --skill technical-writer-toanpv90

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps you evaluate documentation quality and generate a prioritized list of concrete improvements so your docs become clearer, more complete, easier to follow, and better structured.

Core Features & Use Cases

  • Four-dimension review: Scores Clarity, Completeness, Actionability, and Structure on a 1–5 scale without inflating scores.
  • Prioritized fix list: Produces a ranked set of changes ranked by impact, with specific suggested fixes.
  • Best-fit use cases: Use after writing or updating README files, runbooks, API docs, and internal skill/agent documentation to improve reader success.
  • Guardrails: Requires identifying and reading the full target document before scoring, and asks for key missing inputs (document path, audience, purpose).

Quick Start

Ask the AI to review your documentation file by providing the document path, the intended audience, and the document’s purpose.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I evaluate the quality of my README or runbook documentation?

Evaluate documentation quality by scoring Clarity, Completeness, Actionability, and Structure on a 1–5 scale to identify weaknesses. This process requires reading the full target document to produce an impact-ranked list of concrete fixes.

What is the best way to find prioritized fixes for API docs?

The best way to find prioritized fixes is to score the API docs across four quality dimensions and generate a ranked edit list. This highlights the lowest-scoring dimension and provides specific, actionable improvements to tackle first.

Can I use this documentation review tool for agent or skill markdown files?

Yes, you can review agent or skill markdown files by providing the full document path, intended audience, and purpose. It evaluates the content and outputs dimension scores alongside a prioritized list of structural and clarity improvements.

How do I score documentation for actionability and structure?

Score documentation for actionability and structure by assessing the text against a 1–5 scale without inflating scores. Identifying the lowest-scoring dimension highlights exactly where readers struggle to follow instructions or navigate the content.

What do I need to provide to get a documentation quality score?

You need to provide the full target document, its intended audience, and its purpose. The review process requires reading the entire file before generating dimension scores and concrete prioritized edits.