project-doc-init

SKILL开发
开发 未标注权限 许可证不明确
安装这个技能

自动分析项目并生成AI友好的文档体系(AGENTS.md + 配套子文档)。当用户需要初始化项目文档、创建AGENTS.md、设置AI开发文档结构、或提到"项目文档"/"开发文档"/"初始化文档"时触发。

一句话选型结论

按资料字段整理

project-doc-init是开发类的 Agent Skill,安装方式未标注,权限级别未标注,许可证不明确,有可直接复制的安装命令。技能本质是给模型读的说明书,效果取决于模型与客户端;装完先用一个小任务验证,再放进正式流程。

分类开发 安装方式未标注 权限级别未标注权限 许可证许可证不明确
累计安装 未标注 本周 未标注
GitHub 星标 未标注 仓库 未标注
下载量 未标注 技能市场下载数
权限级别 未标注权限 安装前请确认风险范围
许可证 许可证不明确 未说明

安装

未标注
在支持 Skills 的客户端里执行,装完问一句「你有哪些技能」验证
skillhub install user_81da3431/project-doc-init
  1. 1
    确认客户端支持

    确认你的客户端支持 Skills(Claude、Codex、Cursor 等),并升级到较新的版本。

  2. 2
    拿到技能文件

    执行上面的命令安装;也可以把仓库里的 SKILL.md 手动放进客户端的 skills 目录。

  3. 3
    刷新技能列表

    重新打开客户端,或刷新技能列表,让新放进来的技能被加载。

  4. 4
    验证是否生效

    问一句「你有哪些技能」,确认列表里出现它,再拿一个小任务试跑。

技能档案

开发
字段来自技能仓库与公开索引,中文说明由本站标注
作者 / 维护方user_81da3431仓库 未标注 · 版本 未标注
宿主客户端未标注技能可被这些客户端加载
安装方式未标注安装包 community
权限级别未标注权限安装前请确认风险范围
许可证未说明许可证不明确,商用前请自行确认条款
仓库可用性available技能仓库当前是否可访问
最近核验未标注上游最后核验时间 · 数据更新 1791645517
正文体量6.9 KBSKILL.md 原文大小,越大说明说明书写得越细

典型使用场景

3 类
按分类整理的常见用法,具体以 SKILL.md 为准
写代码与改 bug

按需求补代码、定位并修掉报错。

读仓库与生成改动

让模型读懂项目结构,再给出可落地的改动。

跑测试与排查故障

按现象排查问题,补测试用例并复跑。

选择建议

装之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 有可直接复制的安装命令,不用自己翻文档找入口。

先想清楚的地方

  • 没有标注权限级别,实际能做什么要装好后确认。
  • 许可证不明确,商用或二次分发前先到仓库确认条款。
  • 没有做站内核验,内容以作者仓库为准。
  • 技能只是说明书,实际效果取决于模型与客户端,装完先用小任务试一遍。

更适合

  • 需要在开发场景里给模型补一套做法的人。
  • 愿意先读一遍 SKILL.md、确认它会让模型做什么的人。

不太适合

  • 对许可证要求很严、必须明确可商用的人。
  • 只想装完就自动变强、不打算看说明书的人。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
技能权限级别安装方式累计安装宿主客户端安装命令
project-doc-init当前 未标注权限 未标注 未标注 未标注 有
技能审查员 浏览器控制 ClawHub 市场 877.9 万 OpenClaw 有
Vercel React 最佳实践 浏览器控制 GitHub 仓库 849.1 万 Codex、Claude、Cursor 有
GitHub 代码协作 联网访问 ClawHub 市场 763.3 万 OpenClaw 有
网页设计指南 联网访问 GitHub 仓库 668.6 万 Codex、Claude、Cursor 有
本体论 只读 ClawHub 市场 663.7 万 OpenClaw 有

SKILL.md 全文

6.9 KB
模型实际读到的说明书原文,来自技能仓库

Project Doc Initializer

Description

自动分析项目,生成包含行为准则、场景化导航的 AGENTS.md 及配套子文档。无需额外参数,直接激活即可。

Instructions

  1. 分析项目:读取配置文件和目录结构,识别技术栈与架构特点
  2. 生成文档:按 Prompt Template 执行,输出 AGENTS.md + docs/ 子文档
  3. 交付结果:输出文件列表、完整文档内容

边界情况:

  • 无法识别技术栈(无 package.json / go.mod 等)→ 只基于可确认的信息生成文档,不确定的部分向用户提问
  • 配置文件缺失 → 只生成基线文档(AGENTS.md + PROJECT.md),不生成动态文档

Prompt Template

当创建具体项目的文档时,使用以下提示词模板:

你是项目文档规划专家。请为当前项目设计一套 AI 友好的文档体系。

## 项目信息
【从项目文件中自动分析获取】

## 任务要求

请按以下步骤设计:

### Step 1: 分析项目特点
识别技术栈、架构模式、项目结构、开发规范和常用场景。

检测顺序:项目配置文件 → 目录结构 → 源码特征。

无法识别技术栈时:
- 只基于可确认的信息生成文档,不做推断
- 将不确定的部分直接向用户提问,而非在文档中标注"待确认"

### Step 2: 确定文档结构
固定基线(所有项目必有):
1. AGENTS.md(主索引): 行为准则 + 技术栈概览 + 场景导航 + 常用命令
2. docs/PROJECT.md: 技术栈、目录结构、架构模式

动态文档:根据 Step 1 分析结果,按 Step 3 判断逻辑决定是否拆分。

判断原则:某个领域在项目中有足够的独立复杂度,AI 工作时需要单独查阅该领域的信息,则生成独立文档;否则合并到 PROJECT.md。

### Step 3: 根据项目特点设计场景化文档
基于 Step 1 的分析结果,识别项目需要的文档:

1. 回顾 Step 1 发现的项目特征(目录结构、技术栈、架构模式)
2. 对每个特征领域判断:是否有足够的独立复杂度值得独立文档?
   - 是 → 生成独立文档,文档名反映领域含义
   - 否 → 相关内容合并到 PROJECT.md
3. 根据实际生成的文档构建场景导航表

判断示例(展示推理过程,非固定映射):
- "项目有组件目录且组件间有复用关系" → 组件规范复杂度够,独立为 COMPONENT.md
- "项目有数据层但只有2个简单表" → 数据模型复杂度不够,写入 PROJECT.md 即可
- "项目是单文件脚本" → 只生成 AGENTS.md,不拆 docs/

### Step 4: 定义行为准则

 以下内容必须原样嵌入 AGENTS.md,不可省略、不可改写。

 > ## 行为准则
 >
 > ### 1. Think Before Coding
 > **不假设、不隐藏困惑、展示权衡。**
 > - 开发前先读项目文档,了解结构、规范和约束
 > - 按场景导航表按需定位文档,只读任务相关的,不一次性读完
 > - 先按文档执行,未覆盖时再搜索代码/查阅资料
 > - 不确定时先问,不要猜测
 > - 存在多种理解时,列出所有可能
 > - 有更简单的方案就提出来
 > - 搞不明白就停下来,说清楚哪里不明白
 >
 > ### 2. Simplicity First
 > **最小代码解决问题,不做推测性设计。**
 > - 不做需求范围外的功能
 > - 单次使用的代码不做抽象
 > - 没要求的"灵活性"和"可配置性"不加
 > - 不为不可能的场景写错误处理
 > - 避免重复:相同逻辑出现 2+ 次时考虑抽象,说明取舍
 >
 > ### 3. Surgical Changes
 > **只改必须改的,清理自己制造的混乱。**
 > - 不"顺手优化"周边无关代码
 > - 不重构没坏的东西
 > - 遵循现有风格,即使你不认同
 > - 发现无关死代码提出来,不删
 >
 > ### 4. Goal-Driven Execution
 > **定义成功标准,循环验证。**
 > - "加验证" → "先想清楚什么叫通过,再实现"
 > - "修bug" → "先找到最小复现路径,再修复"
 > - "重构X" → "确保行为不变,可用 diff 辅助验证"
 > - 多步任务列出计划:1. [步骤] → verify: [检查]

### Step 5: 编写文档内容

- AGENTS.md: 行为准则(按 Step 4 原文) + 技术栈概览 + 场景导航表 + 常用命令 + 精简注意事项
- docs/PROJECT.md: 技术栈、目录结构、架构模式 + 不够独立文档的领域章节
- 动态子文档: 仅在 Step 3 判断需要独立时生成,内容为规范要点 + 注意事项

## 输出要求

1. 先输出文件列表,区分固定基线和动态文档
2. 编写每个文档的核心内容
3. 场景导航表与实际生成的文档一一对应,不引用不存在的文件
4. 文档命名符合项目实际
5. 不限制技术栈,基于项目实际生成

## 格式要求

- AGENTS.md 控制在 80-120 行(小项目偏下限,大项目偏上限)
- 子文档单文件不超过 200 行
- 使用 Markdown 表格做导航
- 注意事项精简为要点列表,不展开说明
- **禁止套话**:不要"本文档将介绍..."等开头,直接写内容
- **只写必要信息**:规范、约束、关键路径,不写显而易见的内容
- 代码示例仅限必要场景,优先用描述说明规范

```

---

## Examples

### Example 1: Vue 前端项目

**Input:** 初始化项目文档
**Output:**
- AGENTS.md(行为准则 + 场景导航 + 常用命令)
- docs/PROJECT.md(技术栈、目录结构)
- docs/COMPONENT.md(改组件时需单独查阅组件规范)
- docs/API.md(改接口时需单独查阅请求封装和错误处理约定)

### Example 2: 单文件 Node.js CLI 工具

**Input:** 请帮我创建这个项目的 AI 开发文档
**Output:**
- AGENTS.md(行为准则 + 场景导航 + 常用命令)
- docs/PROJECT.md(技术栈、目录结构 + CLI 参数说明合并于此,因内容简短)
- (项目简单,领域信息不足独立文档价值,不生成额外子文档)

### Example 3: 前后端分离全栈项目

**Input:** 设置项目开发文档
**Output:**
- AGENTS.md(行为准则 + 场景导航 + 常用命令)
- docs/PROJECT.md(技术栈、目录结构、架构模式)
- docs/API.md(改接口时需单独查阅接口约定)
- docs/ARCHITECTURE.md(跨模块改动时需单独查阅架构决策)
- docs/DATA_MODEL.md(改数据结构时需单独查阅模型定义)

---

## Notes

- 技能会自动检测项目类型(Vue/React/Node/Go/Python 等)
- 文档结构由项目特点驱动,不预设固定模板
- 小项目可能只需 AGENTS.md + docs/PROJECT.md,无需额外拆分
- 文档路径使用相对路径,便于迁移
- 行为准则由技能硬编码生成,确保任何项目都能获得一致的 AGENTS.md
```

常见问题

5 问
答案由本站依据条目字段整理
project-doc-init怎么安装?

在支持 Skills 的客户端里执行:skillhub install user_81da3431/project-doc-init。安装方式为未标注。装完刷新技能列表或重开客户端。

project-doc-init支持哪些客户端?

资料没有标注宿主客户端,但只要客户端支持 Skills(Claude、Codex、Cursor 等),一般都能加载。

project-doc-init权限高吗,安全吗?

权限级别为未标注权限。安装前先看它会读取或写入哪些内容。

project-doc-init收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于技能本身和所用的模型或客户端,正式使用前按作者说明确认。

project-doc-init用什么许可证?

许可证标注为 未说明(许可证不明确)。商用或二次分发前请到仓库确认条款原文。

热门专题

按场景挑技能
全部专题 →

技能内容以作者仓库为准;分类、权限级别与许可证状态的中文说明为中文整理,最近核验 未标注。