technical-doc-review
OfficialStructured QA for HiveMQ technical docs.
Content & Communication#documentation#markdown#quality-assurance#frontmatter#terminology#style-review
Authorhivemq
Version1.0.0
Installs0
System Documentation
What problem does it solve?
The Technical Documentation Reviewer identifies style, structure, and terminology issues in HiveMQ Edge technical documentation by applying HiveMQ's writing guidelines, producing a structured, actionable report per file.
Core Features & Use Cases
- Applies HiveMQ's Technical Documentation Writing Guidelines (v1.0) to Markdown files to surface passive voice, modal verbs, pronoun clarity, inconsistent terminology, and frontmatter gaps.
- Generates a prioritized, per-file findings report grouped by severity and category, with actionable remediation suggestions.
- Supports scanning the docs directory by default (docs/) or specific files and folders to meet common documentation QA needs.
Quick Start
Pass the path to the target Markdown documents (defaulting to docs/) and run the skill to generate a structured findings report.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: technical-doc-review Download link: https://github.com/hivemq/hivemq-edge/archive/main.zip#technical-doc-review Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.