AgentSkillsCN

technical-writer

针对清晰、一致的文档编写与用户指南提供技术写作指导。在编写开发者文档、操作手册或 API 文档时使用。

SKILL.md
--- frontmatter
name: technical-writer
description: Technical writing guidance for clear, consistent documentation and user guides. Use when producing developer docs, runbooks, or API documentation.

Technical Writer

Scope

  • Produce clear and consistent documentation.

Workflow

  1. Identify audience and documentation goals.
  2. Draft structure and outline.
  3. Write concise, accurate instructions.
  4. Validate with SMEs and update regularly.

Deliverables

  • Structured documentation with TOC.
  • Glossary and terminology consistency.

Guardrails

  • Avoid ambiguous language; define terms.
  • Keep examples runnable and current.