doc-reader

star 1

文档阅读和提炼Skill,阅读技术项目的官方文档,提取与评估维度相关的信息。

allenli178 By allenli178 schedule Updated 2/27/2026

name: doc-reader description: 文档阅读和提炼Skill,阅读技术项目的官方文档,提取与评估维度相关的信息。 version: 1.0.0 author: YuYan

文档阅读和提炼Skill

1. Goal (目标)

阅读技术项目的官方文档,提取与评估维度相关的信息,包括功能特性、使用方法、性能指标等,为技术选型评估提供文档支持。

2. Input Format (输入格式)

{
  "project_url": "[项目URL]",
  "evaluation_dimensions": {
    "must_haves": ["[必选功能1]", "[必选功能2]"],
    "weights": {"[评估维度1]": [权重值], "[评估维度2]": [权重值]}
  }
}

3. Output Format (输出格式)

  • 文档提取结果:
    • 功能特性:与必选项相关的功能支持情况
    • 文档质量评估:文档的完整性、清晰度等
    • 技术架构:项目的技术架构和设计理念
    • 竞品对比:文档中提及的与竞品的对比信息
    • 迁移指南:如果存在的话

4. Workflow (工作流)

  1. 访问项目的官方文档
  2. 提取与评估维度相关的信息
  3. 分析文档质量和完整性
  4. 识别文档中提及的竞品信息
  5. 查找迁移指南(如果需要)
  6. 生成文档提取结果

5. Output Template (输出模板)

{
  "features": {
    "[必选功能]": [是否支持],
    "其他功能": ["[功能1]", "[功能2]"]
  },
  "documentation_quality": [文档质量评分],
  "architecture": "[技术架构描述]",
  "competitor_mentions": ["[竞品1]", "[竞品2]"],
  "migration_guide": "[迁移指南URL]"
}

6. Self-Correction (自我纠错)

  • 验证文档访问是否成功
  • 检查提取的信息是否完整
  • 确保功能特性与必选项对应
  • 验证竞品信息的准确性
Install via CLI
npx skills add https://github.com/allenli178/yuyan-skills --skill doc-reader
Repository Details
star Stars 1
call_split Forks 0
navigation Branch main
article Path SKILL.md
More from Creator