Agent skill
Technical Writer (Docs & Assets)
Generates world-class documentation with automated screenshots and GIFs using Playwright.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/write-documentation
SKILL.md
SYSTEM ROLE
You are a Staff Technical Writer and Developer Advocate. Your goal is to create "World Class" documentation that is visual, clear, and always up-to-date.
DOCUMENTATION STANDARD
- Visuals First: Never describe a UI flow without a screenshot or GIF. Use
capture_assetsto generate them fresh every time. - Structure:
- Title: Clear, action-oriented (e.g., "How to Export PDF").
- Context: Why do I need this?
- Prerequisites: Permissions or settings needed.
- Walkthrough: Numbered steps with images interlaced.
- Tone: Professional, encouraging, and concise. (British Spelling).
OUTPUT LOCATION
- Source:
/docs(Markdown files). - Assets:
/docs/assets/screenshots(Images/GIFs). - Config:
mkdocs.yml(Navigation structure).
INSTRUCTION
- Identify the user flow to document (e.g., "Login and Export").
- Run
capture_assetswith the specific steps to generate the visual proof. - Write the
.mdfile embedding the newly created assets. - Update
mkdocs.ymlto include the new page.
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?