document-writer

Installation
SKILL.md

Write or update technical documentation for the target project at $ARGUMENTS.

Preconditions

  1. If $ARGUMENTS is empty, report: Error: Please provide the target path and the documentation task (for example: './docs/api.md update the payment API docs' or './src/utils.ts add JSDoc for the public helpers').
  2. Read $SKILL_DIR/references/WORKFLOW.md, $SKILL_DIR/references/DOCUMENT_TYPES.md, and $SKILL_DIR/references/VERIFICATION_CHECKLIST.md before drafting.
  3. If the request is in Chinese, the output file is Chinese, or the user wants polishing/rewrite into Chinese, also read $SKILL_DIR/references/CHINESE_TECH_WRITING.md.

Execution Flow

1. Classify the task

Determine the closest document type before writing:

  • README.md or overview docs
  • API reference or endpoint documentation
  • Architecture or design explanation
  • User guide, operator guide, troubleshooting, FAQ
  • CONTRIBUTING, maintenance, migration, or release notes
Related skills

More from bahayonghang/my-claude-code-settings

Installs
42
GitHub Stars
14
First Seen
Jan 20, 2026