Individual skill

developer-docs-editing-review

Edit and review developer documentation for technical accuracy, completeness, structure, clarity, brevity, peer feedback, technical review, technical verification, QA procedure testing, and feedback integration. Use when reviewing, editing, refactoring, or preparing developer docs for release, especially docs with procedures, examples, prerequisites, or high-risk technical claims.

plugins/LVTD-LLC/skills/skills/developer-docs-editing-review/SKILL.md

Read pinned source

Source commit d780783eba4ecc7c8b9429f95c9362df95f07c61

What was checked

Matches the observed repository HEAD
Yes
Scanner rules are current
Yes
Repository scan complete
No
Skill scan complete
No
Observed behavior
Network or broad shell
Last checked
Nov 4, 2026

These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.

Install this skill

Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.

An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.

Repository context

Repository stars (not skill ratings)
1,537
Repository last updated
Nov 7, 2026
License
Apache-2.0

Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.

Files and excerpt

File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.

Browse files
Read excerpt

# Developer Docs Editing Review

Use this skill to improve developer documentation after a draft exists. It treats editing as validation and refactoring: check whether the doc is accurate, complete, structured, clear, brief, and reviewable.

This skill is derived from *Docs for Developers: An Engineer's Field Guide to Technical Writing*, especially Chapter 4, "Editing documentation." It is expanded with paraphrased guidance from Christopher Gales and the Splunk Documentation Team's *The Product Is Docs: Writing Technical Documentation in a Product Development Group*, especially Chapter 15, "Technical Editing," and Chapter 16, "Technical Verification." Do not copy book prose into user outputs. Source: https://link.springer.com/book/10.1007/978-1-4842-7217-6

## Quick Start

1. Load `guidelines.md` to choose the smallest useful reference set.
2. Identify doc type, audience, source of truth, and release risk.
3. Use separate passes for technical accuracy, completeness, structure, clarity, and brevity.
4. Use `workflows/verify-technical-doc.md` when procedures, migrations, security, data, or production changes need formal verification.
5. Use `workflows/edit-developer-doc.md` for a full edit.
6. Return findings first when the user asks for a review; return revised text when the user asks for an edit.