technical-copywriter-review

Review technical writing and report issues by severity with suggested changes.

1|Updated May 3, 2025
One-click install
npx skills add https://github.com/riccjohn/blog --skill technical-copywriter-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-copywriter-review
Source: https://github.com/riccjohn/blog/tree/main/.claude/skills/technical-copywriter-review
Command: npx skills add https://github.com/riccjohn/blog --skill technical-copywriter-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps software teams and technical authors improve the quality of their documentation by identifying issues in correctness, clarity, and structure without rewriting the content, preserving the author's voice.

Core Features & Use Cases

  • Structured feedback framework: categorize issues as Must fix, Should fix, or Consider.
  • Line-numbered, actionable feedback with exact quotes and suggested changes.
  • Non-prescriptive guidance that helps authors retain ownership while improving readability and accuracy.
  • Suitable for API docs, tutorials, READMEs, and code samples.

Quick Start

Paste the text you want reviewed or provide a file path, then request a structured critique. The review will return issues organized by severity and a suggested change template.

Frequently Asked Questions about technical-copywriter-review

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

FAQPage Schema
What is technical writing peer review and how does it identify documentation issues?

Technical writing peer review evaluates API docs, tutorials, and READMEs to identify correctness, clarity, and consistency issues. It provides structured, line-numbered feedback categorized by severity levels without rewriting the original content.

How do I review technical writing for clarity without rewriting the original content?

To review technical writing without rewriting, apply a structured critique framework that highlights issues by severity. The review returns actionable feedback using exact quotes, line numbers, and suggested changes, preserving the author's voice.

Can I use this structured review for API docs and code samples?

Yes, you can use this structured review for API docs, tutorials, READMEs, and code samples. It evaluates technical writing by categorizing issues as Must fix, Should fix, or Consider, providing specific suggestions for each identified problem.

What is the best way to format feedback for a technical documentation review?

The best way to format technical documentation review feedback is using a structured template with severity levels, per-issue details, line numbers, original text quotes, and proposed changes. This ensures actionable, non-prescriptive guidance.

How do I start a peer review for my README file?

To start a peer review for your README, paste the text or provide a file path. The review will return issues organized by severity levels, including the issue type, line number, original quote, suggestion, and proposed change.

Why does the review categorize issues as Must fix, Should fix, or Consider?

The review categorizes issues as Must fix, Should fix, or Consider to prioritize actionable feedback by severity. This non-prescriptive guidance helps authors retain ownership while systematically improving documentation correctness, clarity, and consistency.