skills.rest
jvalinsky
jvalinskyCOMMUNITY
Explore all skills by this author →
GitHub

rewrite-dev-docs-comments

Rewrite engineering documentation and code comments into concise, precise prose.

Updated Jul 26, 2026
Search Tags:#documentation#technical writing#developer experience#clarity#code comments#llm-speak
One-click install
npx skills add https://github.com/jvalinsky/garazyk --skill rewrite-dev-docs-comments
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: rewrite-dev-docs-comments
Source: https://github.com/jvalinsky/garazyk/tree/main/skills/rewrite-dev-docs-comments
Command: npx skills add https://github.com/jvalinsky/garazyk --skill rewrite-dev-docs-comments

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill addresses the issue of low-signal, verbose, or marketing-heavy language in technical documentation and code comments, making them harder for experienced developers to understand and maintain.

Core Features & Use Cases

  • Technical Prose Enhancement: Rewrites engineering documentation and code comments to be concise, precise, and technically accurate.
  • LLM-Speak Reduction: Removes marketing tone, vague claims, filler phrases, and unnatural phrasing common in AI-generated text.
  • Use Case: Improve the clarity of a README file for a complex library by removing jargon and focusing on essential technical details, or refine in-code comments to explain the "why" behind a piece of code, not just the "what."

Quick Start

Scan the file '/path/to/your/document.md' for low-signal language.

Frequently Asked Questions about rewrite-dev-docs-comments

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

FAQPage Schema
How do I remove LLM-speak from technical documentation?▼

To remove LLM-speak from technical documentation, rewrite the text to eliminate vague claims, filler phrases, and marketing tones, replacing them with concise, technically precise prose tailored for experienced developers.

How do I rewrite README files and code comments for experienced developers?▼

Rewrite README files and code comments for experienced developers by focusing on factual accuracy, testable claims, and a peer-developer tone, ensuring the text explains the technical 'why' rather than just the 'what'.

Can I use this to refine design docs and API documentation?▼

You can refine design docs and API documentation by editing the content to remove low-signal language, ensuring the technical prose remains concise, accurate, and highly relevant for engineering audiences.

What's the best way to fix verbose AI-generated code comments?▼

The best way to fix verbose AI-generated code comments is to rewrite them into concise, technically accurate statements that maintain factual accuracy and adhere to a strict quality bar for peer developers.

Does this work for editing PR descriptions and migration notes?▼

Editing PR descriptions and migration notes works by scanning the documents for low-signal language and rewriting the content to produce precise, testable claims suitable for engineering maintenance.

When should I not use automated technical writing tools for engineering docs?▼

You should not use automated technical writing tools when content requires original architectural synthesis, as these tools specifically refine existing engineering documentation and code comments rather than generating new design concepts.

Related Skills

Explore More Software Engineering Skills→
nobe4nobe4
9

grug

Enforce plain language and grug principles to produce concise AI responses.

Community
Intermediate
dreamingechoesdreamingechoes
2

humanize-writing

Rewrite robotic text into clear, natural developer prose.

Community
Basic
getspurgetspur
2

spurpower-receiving-code-review

Verify code review feedback using SPUR code graph tools.

Official
Advanced
Veloxia-agencyVeloxia-agency

copy-editing

Refines existing marketing copy across seven-pass review workflows, preserving voice and improving clarity, persuasion, specificity, emotion, and call-to-action readiness for landing pages, ads, emails, and website sections.

Community
Advanced