review-vocabulary

Review and rewrite branch prose against a fixed vocabulary and Simplified Technical English rules.

5.8k|594|Updated Jan 26, 2022
One-click install
npx skills add https://github.com/dlt-hub/dlt --skill review-vocabulary
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-vocabulary
Source: https://github.com/dlt-hub/dlt/tree/main/.claude/skills/review-vocabulary
Command: npx skills add https://github.com/dlt-hub/dlt --skill review-vocabulary

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Branches in the dlt repository accumulate inconsistent terminology, long sentences, and non-compliant prose across docstrings, comments, error messages, and documentation. This Skill audits a branch diff against dlt's fixed vocabulary and the 53 rules of ASD-STE100 Simplified Technical English, then rewrites the prose so the project says one thing one way.

Core Features & Use Cases

  • Vocabulary enforcement: Applies grouped fixed-vocabulary tables (data access, attach, transformations, identifiers, configuration) with explicit banned terms and legal exceptions.
  • STE rule compliance: Classifies text as procedural or descriptive, enforces 20/25-word sentence limits, condition-first commands, and one instruction per sentence.
  • Safe multi-phase workflow: Audits first with file:line findings, waits for approval, then applies edits in two phases and verifies with AST comparison, linting, formatting, and test runs.
  • Use Case: A maintainer runs /review-vocabulary on a feature branch before merge; the Skill proposes rewrites for docstrings and error messages, flags test assertions that would break, and applies approved changes without touching code.

Quick Start

Ask the assistant to run /review-vocabulary against the current branch to audit and rewrite its prose against dlt's vocabulary and Simplified Technical English rules.

Frequently Asked Questions about review-vocabulary

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

FAQPage Schema
How do I review branch prose against a fixed vocabulary?

Run /review-vocabulary with an optional base ref; it diffs the branch against the merge-base by default. The Skill audits added or changed docstrings, comments, messages, and docs, then proposes rewrites with file, line, rule number, and replacement text before applying anything.

What is Simplified Technical English for documentation?

ASD-STE100 is a controlled language with 53 rules covering sentence length, verb forms, and one-word-one-meaning vocabulary. This Skill enforces 20-word limits for instructions, 25-word limits for descriptions, condition-first commands, and banned modals like should and could.

Does the review change code or only prose?

Only prose. Code, identifiers, signatures, type annotations, and f-string placeholders are never modified. Verification compares the AST with docstrings stripped against the branch tip, so any code change is detected and must be explained.

Why do message rewrites break test assertions?

Tests match on exact error text, and parametrized tests hide assertions far from the message. The Skill greps tests for match= and string assertions, checks negative assertions, and runs the full test suite after applying message rewrites.

When should I not run this vocabulary review?

Do not run it as background cleanup; it rewrites text across dozens of files and changes CI test ids, so a maintainer must invoke it explicitly. Pre-existing prose is out of scope by default unless a whole-file docs review is requested.