New: 98,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Documentation Style

by canonical in canonical/workshop

Enforces project documentation style guide compliance for tone, voice, terminology, punctuation, and formatting.

GPL-3.0Auto-check passedWriting & Content

Install Documentation Style

skills CLI
$ npx skills add canonical/workshop --skill documentation-style -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install canonical/workshop documentation-style --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/canonical/workshop.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.github/skills/documentation-style .claude/skills/documentation-style && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
documentation-style
GitHub stars
114
Token cost
~714 tokens
SKILL.md length
294 words
Files
2 (incl. references)
Skills in repo
6
Repo updated
First seen
Licence
GPL-3.0

At a glance

Enforces project documentation style guide compliance for tone, voice, terminology, punctuation, and formatting.

  • Works in 6 steps: Load style guides: Read… → Syntax compliance: Check headings,… → Full style guide compliance: Read and… → …
  • Checking documentation style
  • SKILL.md covers Scope, Inputs, Actions and Constraints, plus 1 more section
  • Reaches raw.githubusercontent.com

What it does

Documentation Style is an agent skill from canonical/workshop. Enforces project documentation style guide compliance for tone, voice, terminology, punctuation, and formatting. Use when checking documentation style or validating MyST/reST syntax. Cites specific style guide violations.

Its SKILL.md is about 710 tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files, including reference files (for example `references/doc-style-guide.md`).

It sits in Writing & Content. The repository describes itself as: Workshops are secure, fast, and composable development environments that come agent-ready. The licence is GPL-3.0.

When your agent uses it

  • Checking documentation style
  • Validating MyST/reST syntax

Example prompts

  • “Use the documentation-style skill to enforce project documentation style guide compliance for tone, voice, terminology, punctuation, and formatting”
  • “/documentation-style”

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

  1. Load style guides: Read references/doc-style-guide.md.
  2. Syntax compliance: Check headings, lists, code blocks,
  3. Full style guide compliance: Read and apply all rules defined
  4. Style guide citation: For every violation found,
  5. Fallback behaviour: If syntax guides cannot be fetched
  6. Verification

What it can do on your machine

Read from SKILL.md and the folder at commit 0b41ee9. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • raw.githubusercontent.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Documentation Style loads about 714 tokens when it runs, and up to ~8.5k if it reads all its reference files. Until then it costs about 60 tokens; SKILL.md has 294 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~60
When it runs · the whole SKILL.md, loaded when a task matches
~714
With references · SKILL.md plus every file in references/, read only if the agent opens them
~8.5k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from canonical/workshop at commit 0b41ee9, republished under its GPL-3.0 licence (© canonical). 294 words, ~714 tokens.

Download SKILL.mdSave it as .claude/skills/documentation-style/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
documentation-style
description
Enforces project documentation style guide compliance for tone, voice, terminology, punctuation, and formatting. Use when checking documentation style or validating MyST/reST syntax. Cites specific style guide violations.

Documentation Style Review

Scope

Style conformance only: tone, voice, terminology, punctuation, Oxford comma, active versus passive voice, prohibited phrases, and formatting conventions.

Inputs

  • Documentation file(s) under review.
  • Normative style asset: references/doc-style-guide.md.
  • Syntax-specific style guides (fetched at runtime):
    • MyST: https://raw.githubusercontent.com/canonical/sphinx-docs-starter-pack/refs/heads/main/docs/reference/myst-syntax-reference.md
    • reST: https://raw.githubusercontent.com/canonical/sphinx-docs-starter-pack/refs/heads/main/docs/reference/rst-syntax-reference.rst

Actions

  1. Load style guides: Read references/doc-style-guide.md. Fetch the syntax-specific guide matching the file type (MyST for .md, reST for .rst).

  2. Syntax compliance: Check headings, lists, code blocks, inline literals, and directives against the applicable syntax guide. Treat every instruction in the guide as mandatory; do not rely on a subset of rules.

  3. Full style guide compliance: Read and apply all rules defined in references/doc-style-guide.md. Treat every instruction in the guide as mandatory; do not rely on a subset of rules.

  4. Style guide citation: For every violation found, locate and quote the specific passage in references/doc-style-guide.md or the syntax-specific guide that supports the finding.

  5. Fallback behaviour: If syntax guides cannot be fetched (offline or network blocked), continue the review using references/doc-style-guide.md and the syntax patterns already present in the documentation set.

    If references/doc-style-guide.md is unavailable, STOP the review and report that the style guide cannot be accessed.

  6. Verification:

    Confirm the style review completed:

    • Style guides loaded (doc-style-guide.md and syntax-specific guide if available)
    • Syntax compliance checked against applicable guide
    • Style guide compliance checked against all rules in doc-style-guide.md
    • All violations cited with quoted passages from style guides

    State the completion status:

    • ✓ Style review complete: [N] violations found
    • OR ✓ Style review complete: No violations found

Constraints

  • Quote style guides when making style suggestions.
  • Do not suggest style or markup changes without quoting the style guides.

Output

A list of style violations, each accompanied by:

  • The specific passage quoted from the style guide or syntax reference.
  • The observation or suggested change.

© canonical, GPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file (references) in .github/skills/documentation-style of canonical/workshop.

  • SKILL.md
  • references/doc-style-guide.md

Open the folder on GitHubat commit 0b41ee9

Compare with similar skills

Documentation Style next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Documentation Style compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Documentation Style this skillcanonical/workshop114—~714Automated safety check: PassGPL-3.0
Socialcoreyhaines31/marketingskills54k4 repos~4.5kAutomated safety check: PassMIT
HumanizerAzure-Samples/interview-coach-agent-framework17237 repos~5.8kAutomated safety check: PassMIT
Avoid AI Writingconorbronsdon/avoid-ai-writing4.9k3 repos~8.1kAutomated safety check: PassMIT
JavaScript Concept Fact Checkerleonardomso/33-js-concepts67k1 repos~5kAutomated safety check: PassMIT
User-Facing Text Cleanupguillaumemeyer/watermarks-remover24k—~3.5kAutomated safety check: PassMIT

Similar skills

  • Social

    coreyhaines31/marketingskills

    When the user wants help creating, scheduling, or optimizing social media content for LinkedIn, Twitter/X, Instagram, TikTok, or Facebook, or wants to do social listening and engagement triage.

    54k GitHub starsUsed in 4 repos~4.5k tokens
    Writing & ContentAuto-check passed

  • Humanizer

    Azure-Samples/interview-coach-agent-framework

    Official

    Remove signs of AI-generated writing from text. An agent skill from Azure-Samples/interview-coach-agent-framework.

    172 GitHub starsUsed in 37 repos~5.8k tokens
    Writing & ContentAuto-check passed

  • Avoid AI Writing

    conorbronsdon/avoid-ai-writing

    Audit and rewrite content to remove AI writing patterns ("AI-isms").

    4.9k GitHub starsUsed in 3 repos~8.1k tokens
    Writing & ContentAuto-check passed

  • JavaScript Concept Fact Checker

    leonardomso/33-js-concepts

    Verifies the technical accuracy of JavaScript concept pages by checking code examples, MDN and ECMAScript claims and external links through a five-phase method.

    67k GitHub starsUsed in 1 repo~5k tokens
    Writing & ContentAuto-check passed

  • User-Facing Text Cleanup

    guillaumemeyer/watermarks-remover

    Audits prose for invisible Unicode characters and rewrites it while keeping facts, citations, code and required disclosures unchanged and the writer's voice intact.

    24k GitHub stars~3.5k tokensUpdated 2 days ago
    Writing & ContentAuto-check passed

  • Social Content

    freekmurze/dotfiles

    When the user wants help creating, scheduling, or optimizing social media content for LinkedIn, Twitter/X, Instagram, TikTok, Facebook, or other platforms.

    1k GitHub starsUsed in 23 repos~2.1k tokens
    Writing & ContentAuto-check passed

More from canonical/workshop

  • Documentation Build

    canonical/workshop

    Validates documentation builds successfully. An agent skill from canonical/workshop.

    114 GitHub stars~762 tokensUpdated today
    Auto-check passed

  • Documentation Review

    canonical/workshop

    Performs comprehensive documentation review including build validation, Diataxis analysis, structure audit, accuracy verification, and style compliance.

    114 GitHub stars~1.9k tokensUpdated today
    Auto-check passed

  • Documentation Verify

    canonical/workshop

    Verifies documentation accuracy by cross-referencing claims, CLI commands, API signatures, and configuration against source code.

    114 GitHub stars~932 tokensUpdated today
    Auto-check passed

  • Documentation Diataxis

    canonical/workshop

    Analyzes documentation against Diataxis framework (Tutorial, How-to, Reference, Explanation).

    114 GitHub stars~1.6k tokensUpdated today
    Auto-check passed

  • Documentation Structure

    canonical/workshop

    Validates documentation structural integrity including heading hierarchy, metadata, file naming, navigation, and cross-references.

    114 GitHub stars~704 tokensUpdated today
    Auto-check passed

Categories

Questions about Documentation Style

What does Documentation Style do?

Enforces project documentation style guide compliance for tone, voice, terminology, punctuation, and formatting. Documentation Style is an agent skill from canonical/workshop. Enforces project documentation style guide compliance for tone, voice, terminology, punctuation, and formatting.

When should I use Documentation Style?

Documentation Style fits situations like: checking documentation style; validating MyST/reST syntax.

How do I install Documentation Style in Claude Code?

Run `npx skills add canonical/workshop --skill documentation-style -a claude-code`. Or copy the skill folder (.github/skills/documentation-style in canonical/workshop) into .claude/skills/documentation-style in your project. Claude Code loads it when a task matches its description.

How do I install Documentation Style in Codex?

Run `npx skills add canonical/workshop --skill documentation-style -a codex`. Or copy the skill folder (.github/skills/documentation-style in canonical/workshop) into .agents/skills/documentation-style in your project. Codex loads it when a task matches its description.

Can I use Documentation Style in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add canonical/workshop --skill documentation-style -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation-style, .gemini/skills/documentation-style, .github/skills/documentation-style and .opencode/skills/documentation-style in your project.

What does Documentation Style need to run?

SKILL.md names no scripts, command-line tools or credentials: Documentation Style is instructions for the agent only.

Does Documentation Style access the network?

SKILL.md names 1 domain. In commands or code: raw.githubusercontent.com; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is Documentation Style safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Documentation Style use?

Documentation Style is published under the GPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Documentation Style use?

About 714 tokens (SKILL.md is roughly 2.9k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 7.8k tokens, read only when the agent opens those files.

What are the alternatives to Documentation Style?

Skills that share tags, products or a category with Documentation Style: Social (coreyhaines31/marketingskills, 54k stars), Humanizer (Azure-Samples/interview-coach-agent-framework, 172 stars), Avoid AI Writing (conorbronsdon/avoid-ai-writing, 4.9k stars) and JavaScript Concept Fact Checker (leonardomso/33-js-concepts, 67k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Documentation Style?

canonical (a GitHub organization) maintains it in canonical/workshop, which has 114 GitHub stars. The repository holds 6 skills in this directory. The repository was last updated on October 8, 2026.

Source: canonical/workshop on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.