ReddRadar
Agent skill
tech-writing-linter
Lint technical documentation for style, consistency, and readability
Install this agent skill to your Project
npx add-skill https://github.com/a5c-ai/babysitter/tree/main/library/specializations/software-architecture/skills/tech-writing-linter
SKILL.md
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"
}
}
}
}
}
Output Schema
{
"type": "object",
"properties": {
"files": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": { "type": "string" },
"issues": { "type": "array" },
"readabilityScore": { "type": "number" }
}
}
},
"summary": {
"type": "object",
"properties": {
"totalIssues": { "type": "number" },
"byCategory": { "type": "object" },
"averageReadability": { "type": "number" }
}
}
}
}
Usage Example
{
kind: 'skill',
skill: {
name: 'tech-writing-linter',
context: {
paths: ['docs/**/*.md'],
engine: 'vale',
styleGuide: 'google',
options: {
minReadability: 60,
checkTerminology: true
}
}
}
}
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
a5c-ai/babysitter
gsd-tools
Central utility skill for GSD operations. Provides config parsing, slug generation, timestamps, path operations, and orchestrates calls to other specialized skills. Acts as the unified entry point that the original gsd-tools.cjs provided via its lib/ modules (commands, config, core, init).
a5c-ai/babysitter
model-profile-resolution
Resolve model profile (quality/balanced/budget) at orchestration start and map agents to specific models. Enables cost/quality tradeoffs by selecting appropriate AI models for each agent role.
a5c-ai/babysitter
verification-suite
Plan structure validation, phase completeness checks, reference integrity verification, and artifact existence confirmation. Provides the structured verification layer ensuring GSD artifacts are well-formed and complete.
a5c-ai/babysitter
state-management
STATE.md reading, writing, and field-level updates. Provides cross-session state persistence via .planning/STATE.md with structured fields for current task, completed phases, blockers, decisions, and quick tasks.
a5c-ai/babysitter
git-integration
Git commit patterns, formats, and conventions for GSD methodology. Provides atomic commits per task, structured commit messages, planning file commits, branch management, and milestone tag operations.
a5c-ai/babysitter
frontmatter-parsing
YAML frontmatter parsing and manipulation for .planning/ documents. Provides read, write, update, query, and validation operations on frontmatter blocks in GSD markdown artifacts.
Didn't find tool you were looking for?