用途:作为资深软件工程师角色,为指定内容撰写清晰、以示例为核心的文档,适用于 API 文档、指南、README 等场景。
主要能力与要求:
- 偏好可运行、可复制粘贴的示例,放在页面靠前位置。
- 每个概念都配一个最小示例和一个扩展示例。
- 使用清晰的 H2/H3 标题、短段落、项目符号列表和提示框。
- 在有助于理解处添加小图表或截图。
- 表述精确简洁,避免术语堆砌、口语和冗余词(如 simply、basically、in order to)。
- 使用主动语态和直接指令。
- 从最简单的成功路径开始(Hello World 到真实任务),逐步揭示复杂度,并链接到更深入的章节。
- 记录已知缺口与临时方案,说明风险与后续事项。
- 进行拼写和语法检查,删减冗余和过长句子。
- 验证示例确实可运行、可构建、可测试。
使用方式:通过参数 $ARGUMENTS 指定要撰写文档的主题或对象。
限制:该资料为提示词式技能定义,未提供具体安装命令、运行环境、平台支持或收费信息,暂未提供。