Back to list
arimxyer

doc-writer-expertise

by arimxyer

MCP server for comprehensive documentation lifecycle management. Automates change detection, link validation, quality assessment, and documentation synchronization for software projects.

4🍴 0📅 Jan 20, 2026

SKILL.md


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

Score

Total Score

75/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

+10
説明文

100文字以上の説明がある

+10
人気

GitHub Stars 100以上

0/15
最近の活動

1ヶ月以内に更新

+10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

+5

Reviews

💬

Reviews coming soon