用途:在编写或维护 Rails engine 文档(engine README、安装指南、配置文档)时使用。触发词包括 engine README、install guide、engine docs。
主要能力与流程:按步骤组织文档——1 安装(gem add、bundle、运行 install generator,先给出最小可用路径);2 宿主假设(明确说明对宿主模型、任务后端、认证集成的假设);3 配置(列出所有选项及默认值,区分必填与可选);4 挂载(在 routes 中写一次 mount MyEngine::Engine, at: '/path');5 使用(可复制的典型工作流代码);6 迁移(安装生成器、一次性设置、影响升级的变更)。硬性门槛:文档在进入可选章节前必须满足第 1、2、3 步。
必要用法:README 中先写 Gemfile 添加 gem 'my_engine',再执行 bundle install 与 rails generate my_engine:install;挂载示例为 mount MyEngine::Engine, at: '/admin';配置示例在 config/initializers/my_engine.rb 中使用 MyEngine.configure 块。
扩展资源:CHECKLIST.md(推荐 README 结构与缺口清单,跟踪安装步骤、配置默认值、挂载路径、迁移时机、宿主模型/认证假设);assets/configuration.md(配置选项目录、类型、校验规则与默认值);assets/examples.md(端到端用法示例);assets/installation.md(安装与生成器参考)。
输出风格与限制:章节简短、面向任务;用 CHECKLIST.md 校验,每项需有对应章节且含至少一个可复制代码示例或明确陈述,不合格先修复再从头复查,全部关键项通过前不得定稿;明确标注硬性门槛章节与可选章节;升级说明至少含一个可复制代码示例;除明确要求外语言须为英文;避免在多处重复 mount 代码、避免 Ruby/Rails 示例语法错误。可与 create-engine、create-engine-installer、release-engine、generate-api-collection 等技能链式使用。