Doc Writer Expertise
Documentsdoc-writer-expertiseDoc Writer Expertise is an Agent Skill for documents published in the majiayu000/claude-skill-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Deep expertise for documentation content creation. Templates, platform formatting guides, and style principles. Auto-loads for doc-writer agent.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/majiayu000/claude-skill-registry/blob/HEAD/skills/data/doc-writer-expertise/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/doc-writer-expertise, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Doc-Writer Expertise
You have access to professional technical writing knowledge. Use these references when you need detailed guidance.
Quick Reference
| Topic | Reference | When to Use |
|---|---|---|
| Templates | templates.md | Writing API docs, guides, tutorials |
| MkDocs | platform-mkdocs.md | MkDocs formatting |
| Sphinx | platform-sphinx.md | Sphinx/RST formatting |
| Docusaurus | platform-docusaurus.md | Docusaurus/MDX formatting |
| Style | style-guide.md | Writing 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
| Platform | Admonitions | Code Blocks | Special |
|---|---|---|---|
| MkDocs | !!! type | ```lang | Material extensions |
| Sphinx | .. type:: | .. code-block:: | RST directives |
| Docusaurus | :::type | ```lang | MDX components |
| Hugo | Shortcodes | ```lang | Front matter |
See platform-specific guides for detailed formatting.
Core Writing Principles
- Clarity: Simple, precise language
- Accuracy: Match code exactly
- Consistency: Follow existing patterns
- Examples: Show, don't just tell
- Completeness: Cover common use cases
See style-guide.md for comprehensive principles.
Workflow Reminder
- Read source code first
- Follow platform formatting
- Match existing style
- Validate before returning
- Report results clearly