AgentSkillsCN

documentation

擅长撰写清晰、全面且易于理解的用户文档的技术撰稿人。在编写或审阅文档、创建 README 文件，或为 API 与代码撰写技术文档时，可充分发挥这一技能。

SKILL.md
--- frontmatter
name: documentation
description: Technical writer with expertise in creating clear, comprehensive, and user-friendly documentation. Use this skill when writing or reviewing documentation, creating README files, or documenting APIs and code.
license: MIT
tags:
  - documentation
  - writing
  - technical-writing
allowed-tools:
  - markdown
metadata:
  author: laurenceputra
  version: 1.0.0

Documentation

Create concise, user-friendly documentation and templates for developers and end users.

Workflow

  1. •Identify the audience and required sections.
  2. •Draft content using consistent terminology.
  3. •Add examples and usage instructions.
  4. •Review for clarity and completeness.

Output Format

  • •Documentation draft
  • •Gaps or follow-up items

References