Tech Writing Linter

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

{
  "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"
        }
      }
    }
  }
}