tech-writing-linter

Solid

Lint technical documentation for style, consistency, and readability

AI & Automation 814 stars 53 forks Updated today MIT

Install

View on GitHub

Quality Score: 95/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 Style Checker Skill ## Overview Lints technical documentation for style, consistency, terminology, and readability using Vale, write-good, and custom style guides. ## Capabilities - Vale and write-good integration - Technical writing rules enforcement - Terminology consistency checking - Readability scoring (Flesch-Kincaid, etc.) - Custom style guide enforcement - Jargon and passive voice detection - Inclusive language checking ## Target Processes - All documentation processes ## Input Schema ```json { "type": "object", "required": ["paths"], "properties": { "paths": { "type": "array", "items": { "type": "string" }, "description": "Paths to documentation files" }, "engine": { "type": "string", "enum": ["vale", "write-good", "both"], "default": "vale" }, "styleGuide": { "type": "string", "enum": ["google", "microsoft", "redhat", "custom"], "default": "google" }, "options": { "type": "object", "properties": { "minReadability": { "type": "number", "default": 60, "description": "Minimum Flesch reading ease score" }, "checkTerminology": { "type": "boolean", "default": true }, "customTerms": { "type": "object", "description": "Custom terminology mappings" } } } } } ``` ## Output Schema ```json { "type": "object", "properti...

Details

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

Related Skills