How does it handle product-specific terminology?

The skill includes guidance on creating custom Vale vocabularies and internal terminology sheets to prevent synonym drift and ensure brand consistency.

Which style guides are supported by this skill?

The skill primarily follows the Google Developer Documentation Style Guide, with supplemental principles from Microsoft and Apple HIG for warmth and UI copy.

Can this skill help automate my documentation reviews?

Yes, it provides specific configurations and workflows for Vale, allowing you to automate prose linting in your editor and CI/CD pipelines.

What readability targets does the skill aim for?

It targets a Flesch-Kincaid Grade Level of 8-10, an average sentence length of 15-20 words, and less than 10% passive voice usage.

Documentation Style Guide Tool

Name: Documentation Style Guide Tool
Author: wsagency

bywsagency

0•

Gestión de Contenido

Standardizes technical documentation using industry-leading style guides and automated prose linting configurations.

This skill empowers developers and technical writers to produce consistent, high-quality documentation by applying principles from the Google Developer, Microsoft Writing, and Apple HIG style guides. It provides Claude with specific rules for voice, tone, and sentence structure, while also offering technical guidance on implementing Vale for automated prose linting within CI/CD pipelines. It is ideal for teams looking to eliminate synonym drift, improve readability scores, and maintain a professional brand voice across all technical assets.

Características Principales

01Automated prose linting configuration and CI/CD integration with Vale

02Terminology management and standardized vocabulary mapping

03Industry-standard style enforcement based on Google, Microsoft, and Apple guides

04Readability assessment using Flesch-Kincaid and quality metrics

05Guidance on UI-facing copy, error messages, and action-oriented language

060 GitHub stars

Casos de Uso

01Standardizing terminology across large-scale technical projects

02Auditing existing documentation repositories for consistency and tone

03Setting up automated prose linting for GitHub or Gitea workflows

Características Principales

01Automated prose linting configuration and CI/CD integration with Vale

02Terminology management and standardized vocabulary mapping

03Industry-standard style enforcement based on Google, Microsoft, and Apple guides

04Readability assessment using Flesch-Kincaid and quality metrics

05Guidance on UI-facing copy, error messages, and action-oriented language

060 GitHub stars

Casos de Uso

01Standardizing terminology across large-scale technical projects

02Auditing existing documentation repositories for consistency and tone

03Setting up automated prose linting for GitHub or Gitea workflows