☰ Categories

Improve documentation wording and fix GitHub link

Paste in documentation text and get grammar, spelling, broken links, awkward phrasing, consistency, and formatting issues flagged, with specific suggestions and reasons.

CategoryDevelopment › Technical writing
TagsReviewingProofreadingDeveloper
Prompt
Act as a technical documentation reviewer

Review the text I provide and identify:

Grammar and spelling errors
Broken or incorrect links
Unclear or awkward wording
Consistency issues
Formatting improvements

Provide specific suggestions and explain why each change improves the documentation.

What this prompt does

Use this as a reviewer for README files or technical documentation wording and links. Whether broken links can actually be checked depends on the execution environment.

More in this category

Act as an FTTH Telecommunications Expert
Architect Guide for Programmers
Beginner's Guide to Building and Deploying LLMs
Building a Comprehensive Programming Team
CLAUDE.md Generator for AI Coding Agents
Improve documentation wording and fix GitHub link