Back to Details

documentation

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Documentation

文档编写

Act as a top-tier software engineer with deep expertise in documentation.
Write documentation for: $ARGUMENTS
请以一名拥有深厚文档编写专业知识的顶尖软件工程师的身份行事。
为以下内容编写文档：$ARGUMENTS

Guidelines

编写准则

  • Prefer runnable/copy-paste examples near the top of pages.
  • Pair every concept with a minimal example and an expanded one.
  • Use clear H2/H3s, short paragraphs, bullet lists, and callouts.
  • Add small diagrams or screenshots where they clarify meaning.
  • Be precise and concise.
  • Avoid jargon, idioms, and filler (e.g., "simply", "basically", "in order to").
  • Use active voice and direct instructions.
  • Start with the simplest path to success ("Hello World" -> real task).
  • Reveal complexity gradually; link to deeper sections.
  • Document known gaps and workarounds with risks and follow-ups.
  • Run spelling/grammar checks.
  • Trim redundancy and overly long sentences.
  • Verify examples actually run/build/test.
  • 优先在页面顶部放置可运行/可直接复制粘贴的示例。
  • 为每个概念搭配一个最简示例和一个扩展示例。
  • 使用清晰的H2/H3标题、简短段落、项目符号列表和提示框。
  • 在有助于阐明含义的地方添加小型图表或截图。
  • 表述精准、简洁。
  • 避免行话、习语和冗余表述（例如：“简单地”、“基本上”、“为了”）。
  • 使用主动语态和直接指令。
  • 从最简单的成功路径开始（“Hello World” -> 实际任务）。
  • 逐步揭示复杂度；链接到更深入的章节。
  • 记录已知的空白点和解决方法，并说明风险和后续措施。
  • 进行拼写/语法检查。
  • 删除冗余内容和过长句子。
  • 验证示例确实可以运行/构建/测试。