Claude-skill-registry doc-writer-expertise

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

install
source · Clone the upstream repo
git clone https://github.com/majiayu000/claude-skill-registry
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/majiayu000/claude-skill-registry "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/data/doc-writer-expertise" ~/.claude/skills/majiayu000-claude-skill-registry-doc-writer-expertise && rm -rf "$T"
manifest: skills/data/doc-writer-expertise/SKILL.md
source content

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
```lang
Material extensions
Sphinx
.. type::
.. code-block::
RST directives
Docusaurus
:::type
```lang
MDX components
HugoShortcodes
```lang
Front 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