tech-writing-lint

Solid

Automated technical writing style and quality enforcement. Lint documentation with Vale, check for inclusive language, enforce style guides, and analyze readability metrics.

Code & Development 814 stars 53 forks Updated today MIT

Install

View on GitHub

Quality Score: 98/100

Stars 20%
97
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Technical Writing Lint Skill Automated technical writing style and quality enforcement. ## Capabilities - Vale linting with custom style rules - Write-good suggestions for clarity - Alex.js for inclusive language checking - Proselint for style violations - Readability scoring (Flesch-Kincaid, Gunning Fog) - Terminology consistency checking - Microsoft/Google style guide compliance - Custom vocabulary/jargon management ## Usage Invoke this skill when you need to: - Enforce writing style standards - Check documentation quality - Validate terminology consistency - Analyze content readability - Ensure inclusive language ## Inputs | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | inputPath | string | Yes | Path to documentation file or directory | | action | string | Yes | lint, readability, terminology, inclusive | | styleGuide | string | No | Style guide to apply (google, microsoft, custom) | | configPath | string | No | Path to Vale or custom config | | glossaryPath | string | No | Path to terminology glossary | | minReadability | number | No | Minimum readability score (0-100) | ### Input Example ```json { "inputPath": "./docs", "action": "lint", "styleGuide": "google", "configPath": ".vale.ini", "minReadability": 60 } ``` ## Output Structure ### Lint Output ```json { "files": 25, "errors": 8, "warnings": 34, "suggestions": 56, "issues": [ { "file": "docs/api/authentication.md", "line...

Details

Author
a5c-ai
Repository
a5c-ai/babysitter
Created
4 months ago
Last Updated
today
Language
JavaScript
License
MIT

Related Skills