mcpField
D
document-engine

document-engine

github.com/igmarin开发2838 次安装4 周前更新
代码仓库

关于 document-engine

document-engine 是用于编写和维护 Rails engine 文档的技能，面向文档作者。它按安装、宿主应用假设、配置、挂载、用法和迁移组织内容，并用检查清单核对文档缺口。

主要功能

  1. 01文档必备章节门槛
  2. 02Rails 安装与挂载指导
  3. 03配置默认值和必填项说明
  4. 04基于清单检查文档
  5. 05升级说明与示例要求

适用场景

  1. 01编写 Rails engine README
  2. 02检查文档缺失的设置细节
  3. 03准备迁移和升级说明

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/igmarin/rails-agent-skills --skill document-engine

安装后在 Claude Code 中输入/document-engine确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

CHECKLIST.md
assets/
configuration.md
examples.md
installation.md

详细介绍

Document Engine

在编写或维护 Rails 引擎文档时使用此技能。

核心流程与约束

步骤章节重点
1安装添加 gem、运行 bundle、运行安装生成器——先展示最简可用路径
2宿主假设明确说明对宿主模型、任务后端或身份验证集成的任何假设
3配置列出所有选项及默认值，并说明哪些是必需项、哪些是可选项
4挂载在路由中明确写出 mount MyEngine::Engine, at: '/path'——只展示一次
5用法提供可复制的典型工作流代码
6迁移安装生成器、一次性设置、影响升级的变更

硬性门槛： 所有生成的文档在进入可选章节前，必须满足上述步骤 1、2 和 3。

README 片段（安装 + 挂载）：

## Installation

Add to your Gemfile:

    gem 'my_engine'

Run:

    bundle install
    rails generate my_engine:install

This creates `config/initializers/my_engine.rb`. Mount the engine in `config/routes.rb`:

    mount MyEngine::Engine, at: '/admin'

配置章节：

## Configuration

In `config/initializers/my_engine.rb`:

    MyEngine.configure do |config|
      config.user_class = "User"       # required: host model for current user
      config.widget_count = 10         # optional, default 10
    end

扩展资源

完整的推荐 README 结构和文档缺漏检查清单请参阅 CHECKLIST.md。其中跟踪的关键缺漏包括：安装步骤、所有配置选项及其默认值、明确的挂载路径、迁移时机、宿主模型／身份验证假设。

  • assets/configuration.md — 详细的配置选项目录，包含类型信息、验证规则和所有受支持的默认值
  • assets/examples.md — 真实的端到端用法示例，涵盖常见的宿主应用集成工作流
  • assets/installation.md — 分步安装说明和生成器参考，包括安装后的设置任务

输出风格

  1. 章节应简短，并以任务为导向。
  2. 对照 CHECKLIST.md 验证：当文档包含对应章节，且至少有一个可复制代码示例或明确的文字说明时，清单项才算通过；如果缺失、不完整或缺少具体示例，则算未通过。修复每个未通过项，然后从头重新检查。所有关键项通过后才能定稿。
  3. 章节划分：明确标注必需的“硬性门槛”章节（安装、配置、宿主假设）和“可选”章节（扩展点、用法示例）。
  4. 升级说明：在任何升级说明章节中，至少包含一个可复制的代码示例。
  5. 语言——除非另有明确要求，否则必须使用英语。

应避免的常见问题：

  • 在多个章节中重复 mount MyEngine::Engine ...——只在主要安装／挂载章节中展示一次。
  • Ruby／Rails 代码示例存在语法错误——仔细检查路由挂载和身份验证代码块（例如 authenticate :user, ->(u) { u.admin? } do）。

集成

技能何时串联
create-engine需要记录宿主应用契约、结构和扩展点时
create-engine-installer需要记录安装生成器和设置步骤时
release-engine需要记录变更日志、升级说明和版本文档时
generate-api-collection记录或添加 API 端点时（保持 Postman 集合同步）

评论

支持 Markdown