Token导航 LogoToken导航TokenDH.com
研究检索只读github未标认证来源可访问clear审计未展示

proj-doc-eval项目文档评估

Agent Skill

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径,不要把未确认的信息写成确定结论;涉及对外文案时,还需要控制语气,避免过度营销或夸大能力。

总安装

549

周安装

22

GitHub Stars

公开资料未说明

下载量

178
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

GitHub

来源数

2

许可证

MIT

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:proj-doc-eval(项目文档评估)
来源仓库:https://github.com/mcloone/skills
仓库路径:skills/proj-doc-eval
安装命令:
npx skills add mcloone/skills --skill "proj-doc-eval"
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill;本站只展示命令,不托管安装包,也不自动执行。

AgentSkills.tonpx skills
npx skills add mcloone/skills --skill "proj-doc-eval"

简介

用于辅助文档、README、Markdown 等内容的整理与改写,适合提炼结构、统一术语或生成可读性强的内容稿件。

  • 适用于项目文档优化和内容生成场景,支持结构梳理和语言风格调整。
  • 可通过 npx skills add mcloone/skills --skill "proj-doc-eval" 安装使用。
  • 使用时需保留项目已有事实和路径信息,避免将推测写成确定结论。
  • 涉及对外文案时应控制语气,防止过度营销或能力夸大。

SKILL.md

name
proj-doc-eval
description
Evaluate project documents (feature requests, initiatives, epics, etc.) against structured templates. Use when users need to assess document completeness, identify missing elements, or get improvement suggestions for project documentation. Supports markdown, PDF, and Word documents with built-in templates following the natural project flow (feature request → initiative → epic), plus custom template support.
metadata
author
McLoone
version
1.0.0

Project Document Evaluation

Evaluate project documents against structured templates to ensure completeness and quality.

Document Workflow

This skill supports the natural project documentation flow:

  1. Feature Request - Initial idea or user need
  2. Initiative - Strategic response with solution proposal
  3. Epic(s) - Planned implementation work (epics can depend on each other; planning happens outside epic descriptions)

Operations

This skill supports the following operations:

1. Evaluate Document with Specified Template

User provides both a document and specifies which template to use.

Examples:

  • "Evaluate docs/feature.md against the feature request template"
  • "Check my epic using the epic template"
  • "Use the initiative template to evaluate initiative.md"

2. Evaluate Document (Template Selection Prompt)

User provides a document but doesn't specify which template. The skill will ask which template to use.

Examples:

  • "Evaluate docs/project-proposal.md"
  • "Check this document for completeness"
  • "Help me evaluate my project document"

3. Evaluate Document with Custom Template

User provides both a document and a custom template file.

Examples:

  • "Evaluate docs/proposal.md using my-template.md as the template"
  • "Compare this document against custom-template.md"

Workflow

  1. Identify the document - User specifies the document to evaluate (markdown, PDF, or Word file)
  2. Select template - Choose from built-in templates or use a custom template (see Template Selection Guide below)
  3. Read the document - Load and analyze the document content
  4. Evaluate against template - Assess completeness, quality, and alignment with template criteria
  5. Generate report - Provide evaluation results, missing elements, and specific improvement suggestions

Template Selection Guide

When Template is Specified

If the user explicitly specifies which template to use (e.g., "evaluate against the initiative template" or "use the epic template"), proceed directly with that template.

When Template is NOT Specified

If the user provides a document to evaluate without specifying which template to use:

  1. Ask the user which template to use via the AskUserQuestion tool
  2. Present the three built-in template options with their descriptions:

- Feature Request - For initial feature ideas and user needs - Initiative - For strategic initiatives with solution proposals - Epic - For planned implementation work - Custom Template - User provides their own template file path

  1. After the user selects, proceed with the evaluation using the chosen template

Example prompt when template is unclear:

Which template should I use to evaluate this document?

Options:
- Feature Request: Best for initial feature ideas, user needs, and product enhancement proposals
- Initiative: Best for strategic initiatives with solution proposals and desired outcomes
- Epic: Best for planned implementation work with user stories and technical details
- Custom Template: You can provide the path to your own template file

Template Selection

Built-in Templates

Each template is independent but follows the natural project flow. Read the appropriate template from references/:

  • feature-request-template.md - Initial feature ideas and user needs that start the process
  • initiative-template.md - Strategic initiatives with solution proposals (often created from feature requests)
  • epic-template.md - Planned implementation work (created from initiatives; epics can depend on each other)

Custom Templates

If the user provides a custom template:

  • Read the custom template file they specify
  • Use the same evaluation workflow with their criteria

For guidance on creating custom templates, see references/custom-template-guide.md.

Evaluation Process

For each template section:

  1. Check presence - Is the section present in the document?
  2. Assess completeness - Are all required elements included?
  3. Evaluate quality - Does the content meet the quality criteria?
  4. Note gaps - What specific elements are missing or weak?

Output Format

Provide a structured evaluation report with:

1. Overall Assessment

Brief summary of document quality and readiness

2. Section-by-Section Evaluation

For each template section:

  • Status: Complete ✓ | Partial ⚠ | Missing ✗
  • Findings: What's present, what's missing, quality issues
  • Specific Improvements: Concrete suggestions for enhancement

3. Priority Recommendations

Top 3-5 most critical improvements ranked by impact

4. Next Steps

Clear action items to address gaps

Example Usage

User: "Help me evaluate docs/payment-system-initiative.md according to the initiative template"

Process:
1. Read references/initiative-template.md
2. Read docs/payment-system-initiative.md
3. Evaluate each section against criteria
4. Generate improvement suggestions

Note on Document Flow

While templates are independent and can be used in any order, they naturally support this progression:

  • Feature Request identifies a need or opportunity
  • Initiative proposes a strategic solution (may reference the originating feature request)
  • Epic(s) break down implementation (may reference the parent initiative; epics can depend on each other)

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

04

需要参考平台分布和安装热度时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明,方便继续核验

能力 4

补充不同宿主或平台的使用分布数据

安装后应在对应宿主中按原始 README 的触发条件使用;具体调用方式请以来源页面和 README 为准。

平台分布

Claude Code

28.76%
按下载量换算51

windsurf

22.16%
按下载量换算39

OpenCode

20.38%
按下载量换算36

Codex

12.89%
按下载量换算23

Antigravity

8.67%
按下载量换算15

Gemini CLI

3.77%
按下载量换算7

安全审计

暂无安全审计结果可展示。

权限和风险

只读

该 Skill 主要提供规则、说明或参考内容,本身偏只读;真正读写文件、联网或执行命令仍取决于宿主 Agent 的任务。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。当前只有一个来源,正式发布前建议补源仓库或其他目录站核验。

来源信息

继续浏览同类 Skills