Stats
Actions
Tags
From docs-agent
Knowledge about documentation style guides and prose linting for consistent, high-quality technical writing
How this skill is triggered — by the user, by Claude, or both
Slash command
/docs-agent:style-guideThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
This skill provides knowledge about industry-standard writing style guides for technical documentation, prose linting with Vale, and agency-specific terminology management.
This skill provides knowledge about industry-standard writing style guides for technical documentation, prose linting with Vale, and agency-specific terminology management.
The Google style guide (CC-BY 4.0, freely usable) is the recommended base for all documentation at websolutions.hr. Key rules:
code for commands, filenames, parameters, valuesWhere Microsoft's guide complements Google's:
For UI-facing copy and error messages:
Maintain an internal terminology sheet. Decide once, use everywhere:
| Preferred Term | Avoid | Reason |
|---|---|---|
| sign in | log in, login | Industry standard |
| select | check, tick | Platform-neutral |
| Modern convention | ||
| open source | open-source | When used as noun |
Vale enforces style rules automatically in CI and editors.
StylesPath = docs/vale/styles
MinAlertLevel = warning
Packages = Microsoft, Google, write-good
[docs/**/*.md]
BasedOnStyles = Microsoft, Google, write-good
# Custom vocabulary
Vocab = WebSolutions
Create docs/vale/styles/Vocab/WebSolutions/accept.txt for product names, technical terms, and brand names that Vale should not flag.
# .gitea/workflows/vale.yml
name: Prose Lint
on:
pull_request:
paths: ['docs/**/*.md']
jobs:
vale:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: errata-ai/vale-action@v2
with:
files: docs/
Install the Vale VS Code extension for all team members. This gives real-time feedback while writing.
Good documentation meets these measurable criteria:
references/ for detailed guidelinesexamples/ for before/after rewritesnpx claudepluginhub wsagency/ws-claude-marketplace --plugin docs-agentApplies technical writing patterns to developer documentation: API structure, README organization, error messages, and voice. Use for reviewing docs, READMEs, API refs, and error strings.
Guides technical documentation with principles for second-person voice, active voice, conciseness, clear headings, self-contained pages, and LLM-friendly patterns. Use when writing or reviewing docs.
Generates or remediates Markdown documentation with style rules: grounded claims, active voice, imperative docstrings, no jargon or filler. For new docs, AI rewrites, style profiles.