AgentSkillsCN

doc-writer-expertise

在文档内容创作领域拥有深厚的专业知识。涵盖模板、平台格式化指南以及风格准则，并为文档撰写助手提供自动加载功能。

SKILL.md
--- frontmatter
name: doc-writer-expertise
description: Deep expertise for documentation content creation. Templates, platform formatting guides, and style principles. Auto-loads for doc-writer agent.

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