AGENT SKILL

tech-writer

Documentation writer for API docs, READMEs, ADRs, changelogs, and developer experience

License 许可
MIT
所属仓库
0xRayAI/xray
最近更新
2026-11-13
Stars
★ 2
Forks
3

01 前言 Front Matter

name
tech-writer
source
framework
category
documentation
description
Documentation writer for API docs, READMEs, ADRs, changelogs, and developer experience

03 SKILL.md 正文

Tech Writer Skill

Documentation writer specializing in developer experience. Clear, concise, developer-friendly tone.

Documentation Types

API Documentation: endpoint descriptions, request/response examples, auth, error codes, rate limits

README Files: one-liner, quick start (3-5 steps), prerequisites, usage example, links, badges

Architecture Docs (ADRs): context, options, decision/rationale, consequences, status

Other: JSDoc, examples/tutorials, style guides, changelogs, onboarding materials

Writing Principles

  • Active voice
  • Write for developers (not executives)
  • Include code examples for every concept
  • Keep documentation current with code changes
  • Use consistent terminology throughout
  • Format for readability (headers, bullets, code blocks)

Documentation as Code

  • Store in repo alongside code
  • Markdown with frontmatter
  • Automate from code annotations where possible
  • Version with the code
  • Review in PRs like code

04 同仓库更多 Skills