Generate clean, professional technical documentation following specific structure and tone requirements.
Install
mkdir -p .claude/skills/docs && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/4926" && unzip -o skill.zip -d .claude/skills/docs && rm skill.zipInstalls to .claude/skills/docs
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
ALWAYS use this when writing docsKey capabilities
- →Standardize page title length to 2-3 words
- →Enforce section divider syntax with three dashes
- →Apply imperative mood to section titles
- →Format code snippets to remove trailing semicolons
- →Strip trailing commas from JS/TS code blocks
How it works
Applies a set of stylistic transformation rules to existing markdown content to meet structural and tone guidelines.
Inputs & outputs
When to use docs
- →Write project documentation
- →Format technical guides
- →Standardize documentation tone and structure
About this skill
You are an expert technical documentation writer
You are not verbose
Use a relaxed and friendly tone
The title of the page should be a word or a 2-3 word phrase
The description should be one short line, should not start with "The", should avoid repeating the title of the page, should be 5-10 words long
Chunks of text should not be more than 2 sentences long
Each section is separated by a divider of 3 dashes
The section titles are short with only the first letter of the word capitalized
The section titles are in the imperative mood
The section titles should not repeat the term used in the page title, for example, if the page title is "Models", avoid using a section title like "Add new models". This might be unavoidable in some cases, but try to avoid it.
Check out the /packages/web/src/content/docs/docs/index.mdx as an example.
For JS or TS code snippets remove trailing semicolons and any trailing commas that might not be needed.
If you are making a commit prefix the commit message with docs:
When not to use it
- →Writing casual informal forum posts
- →Creating extremely long-form technical whitepapers
Limitations
- →Requires manual content creation prior to formatting
- →May conflict with specific external documentation templates
How it compares
It automatically enforces a specific, rigid technical documentation style guide rather than just correcting grammar.
Compared to similar skills
docs side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| docs (this skill) | 1 | 6mo | No flags | Beginner |
| write-docs | 6 | 3mo | No flags | Beginner |
| docs-changelog | 4 | 4mo | No flags | Beginner |
| docs-writer | 4 | 3mo | No flags | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by revokslab
View all by revokslab →You might also like
write-docs
tldraw
Writing SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Applies to docs in apps/docs/content/.
docs-changelog
google-gemini
Provides a step-by-step procedure for generating Gemini CLI changelog files based on github release information.
docs-writer
google-gemini
Always use this skill when the task involves writing, reviewing, or editing files in the `/docs` directory or any `.md` files in the repository.
technical-docs
getsentry
Write and review technical documentation for Sentry SDK docs. Use when creating, editing, or reviewing documentation pages, especially MDX files in docs/platforms/.
vuepress-plume-markdown
pengzhanbo
Help users write markdown files with VuePress Plume theme extensions, charts, and embeds.
repo-website-guide-create
open-circle
Create conceptual documentation and tutorial pages for the Valibot website at website/src/routes/guides/. Use when adding guides about schemas, pipelines, async validation, migration, or other topics. Covers directory structure, MDX templates, frontmatter, and content guidelines.