用途:为 Ruby gem 编写或更新 README,遵循 Andrew Kane 风格的模板结构,产出清晰、简短的文档。
主要能力:按固定顺序组织章节,依次为带徽章的标题、安装、快速开始、用法、选项(如需要)、升级(如适用)、贡献、许可证;全程使用祈使语气(Add、Run、Create,而非 Adds、Running、Creates);每句不超过 15 个词;定稿前删除所有 HTML 注释。
格式规则:每个逻辑示例只用一个代码围栏,不合并多个概念;代码块之间尽量少写说明文字;标准章节使用固定措辞(如“Add this line to your application's Gemfile:”);代码示例使用两空格缩进;代码内联注释小写且不超过 60 字符;选项表格不超过 10 行,每行一句描述。
标题部分:以 gem 名称为主标题,加一句说明 gem 用途的标语,最多 4 个徽章(Gem Version、Build、Ruby version、License),徽章 URL 使用需替换的占位符。快速开始部分给出最快上手路径,通常是生成器命令或简单初始化,代码围栏之间不加解释文字。用法示例至少包含一个基础示例和一个进阶示例,基础示例展示最简用法,进阶示例展示关键配置选项,仅在必要时加简短内联注释。
完成前检查:确认所有句子不超过 15 个词、动词均为祈使形式、章节顺序正确、占位值清晰标注、无残留 HTML 注释、代码围栏各自单一用途。
限制:资料未提供具体安装命令、依赖、平台支持、收费或价格信息;该技能面向 Ruby gem 文档写作,不涉及其他语言或非文档类任务。