SuperAPI AI 工具集

ankane-readme-writer

写作与研究

查看项目

更新于 10-16 07:26

技能介绍

用途:为 Ruby gem 创建或更新符合 Ankane 风格模板的 README 文档,面向 Ruby 生态的文档写作场景。

主要能力:严格按固定结构组织内容,顺序为头部(含徽章)、安装、快速开始、用法、选项(如需)、升级(如适用)、贡献、许可证;全程使用祈使语气(如 Add、Run、Create);每句不超过 15 个词;定稿前删除所有 HTML 注释。

格式规则:每个逻辑示例使用独立代码围栏,不混合多个概念;代码块之间尽量少写说明文字;标准章节使用固定措辞;代码示例两空格缩进;行内注释小写且少于 60 字符;选项表格不超过 10 行且描述一行。

头部写法:包含 gem 名称作为主标题、一句话标语,最多 4 个徽章(Gem Version、Build、Ruby 版本、License),徽章 URL 带需替换的占位符。

快速开始:给出最快上手路径,通常是生成器命令或简单初始化,代码围栏之间不加解释。

用法示例:至少包含一个基础示例和一个进阶示例,基础示例展示最简用法,进阶示例演示关键配置,仅在必要时加简短行内注释。

完成前检查:确认句子均在 15 词内、动词为祈使形式、章节顺序正确、占位值清晰标注、无残留 HTML 注释、代码围栏用途单一。

限制:资料未提供具体产品定价、平台支持范围、安装命令或运行环境要求,暂未提供更多可验证细节;实际使用需自行替换徽章与占位符。