Skip to content
doc-writer-expertise logo

Doc-Writer Expertise

doc-writer-expertise

Deep expertise for documentation content creation. Templates, platform formatting guides, and style principles. Auto-loads for doc-writer agent.

SKILL.md

Full skill instructions

Doc-Writer Expertise

You have access to professional technical writing knowledge. Use these references when you need detailed guidance.

Quick Reference

TopicReferenceWhen to Use
Templatestemplates.mdWriting API docs, guides, tutorials
MkDocsplatform-mkdocs.mdMkDocs formatting
Sphinxplatform-sphinx.mdSphinx/​RST formatting
Docusaurusplatform-docusaurus.mdDocusaurus/​MDX formatting
Stylestyle-guide.mdWriting principles

Documentation Types

API Documentation

For functions, classes, methods:

  • Parameters with types
  • Return values
  • Exceptions/​errors
  • Code examples

See templates.md for templates.

Guides & Tutorials

For learning content:

  • Step-by-step instructions
  • Conceptual explanations
  • Working examples

Reference Documentation

For comprehensive coverage:

  • All options documented
  • Default values noted
  • Cross-references

Platform Quick Reference

PlatformAdmonitionsCode BlocksSpecial
MkDocs!!! type```langMaterial extensions
Sphinx.. type::.. code-block::RST directives
Docusaurus:::type```langMDX components
HugoShortcodes```langFront matter

See platform-specific guides for detailed formatting.

Core Writing Principles

  1. Clarity: Simple, precise language
  2. Accuracy: Match code exactly
  3. Consistency: Follow existing patterns
  4. Examples: Show, don't just tell
  5. Completeness: Cover common use cases

See style-guide.md for comprehensive principles.

Workflow Reminder

  1. Read source code first
  2. Follow platform formatting
  3. Match existing style
  4. Validate before returning
  5. Report results clearly

More Productivity & Planning skills

brainstorming logo
Productivity & Planning

brainstorming

Structured design dialogue that validates ideas before implementation begins.

295.4K 385.7K
View
ui-ux-pro-max logo
Productivity & Planning

ui-ux-pro-max

Comprehensive design intelligence for web and mobile UI/UX across 10 technology stacks.

133.1K 383.9K
View
writing-plans logo
Productivity & Planning

writing-plans

Comprehensive implementation plans for multi-step tasks, breaking down specs into bite-sized, testable steps.

295.4K 268K
View
using-superpowers logo
Productivity & Planning

using-superpowers

Introduction to the obra skills system with mandatory skill invocation rules and best practices.

295.4K 259.8K
View
executing-plans logo
Productivity & Planning

executing-plans

Execute a written implementation plan with critical review and task checkpoints.

295.4K 229.1K
View
dispatching-parallel-agents logo
Productivity & Planning

dispatching-parallel-agents

Delegate independent tasks to specialized agents working concurrently with isolated context.

295.4K 206.3K
View
using-git-worktrees logo
Productivity & Planning

using-git-worktrees

Isolated git worktrees with smart directory selection and safety verification.

295.4K 205.2K
View
webapp-testing logo
Productivity & Planning

webapp-testing

Toolkit for interacting with and testing local web applications using Playwright. Supports verifying frontend functionality, debugging UI behavior, capturing browser screenshots, and viewing browser logs.

179.7K 170.6K
View
content-strategy logo
Productivity & Planning

content-strategy

Plan searchable and shareable content that drives traffic, builds authority, and generates leads.

53.3K 150.9K
View
repo-intake-and-plan logo
Productivity & Planning

repo-intake-and-plan

README-first repository scanner that extracts commands and classifies reproduction candidates without executing them.

497 139.6K
View
marketing-ideas logo
Productivity & Planning

marketing-ideas

Brainstorm and prioritize marketing strategies tailored to your SaaS stage, budget, and goals.

53.3K 137.2K
View
site-architecture logo
Productivity & Planning

site-architecture

Plan and optimize your website's page hierarchy, navigation, URL structure, and internal linking.

53.3K 112.8K
View

Productivity AI tools

Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View
SaveDay logo
Productivity

SaveDay

Capture, organize, and utilize your knowledge effortlessly.

Free
View
Any Summary logo
Productivity

Any Summary

Instant Summaries of Audio & Video Interviews with AnySummary

Freemium
View
M
Productivity

Map This

Transform PDFs into engaging mind maps.

Freemium
View
ChatPDF logo
Productivity

ChatPDF

Chat with any PDF instantly

Free
View
I
Productivity

intellisay

Create an optimal daily plan using your voice

Paid
View
A
Productivity

Aurora AI

A productivity platform to centralize organizational knowledge and workflows with contextual AI assistance.

Paid
View
AskYourPDF logo
Productivity

AskYourPDF

AskYourPDF Pricing Plans: Tailored to Your Needs

Free
View