project knowledge write

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

把项目源码通读分析后,按 Obsidian 规范生成(或对既有文档增量补充)一套知识文档(每个源文件/模块一篇 .md,函数、结构体、枚举都用 markdown # 标题单独说明其作用,交叉引用一律用 [[]] 语法),并在此基础上为该项目生成"阅读理解/开发" skill(基于分析文档阅读、修改、编译源码并测试编译产物)。适用于用户要求"分析/通读/梳理某项目"、"把项目或某模块代码写成文档/笔记"、"以某种规范描述项目"、或"在已有分析文档上增量优化补充并生成开发 skill",且给出(或可获取)项目路径与文档路径的场景。支持两种运行模式:全量(文档目录为空时从源码生成)与增量(文档目录已有分析文档时理解既有文档、确认项目路径、增量补充后直接生成开发 skill)。启动时需确认输入:文档保存路径、项目路径、运行模式、是否生成开发 skill,以及所需工具是否齐备(缺失的工具要向用户说明并询问是否自动安装)。

一句话选型结论

按资料字段整理

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

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

安装

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

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

  2. 2
    拿到技能文件

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

  3. 3
    刷新技能列表

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

  4. 4
    验证是否生效

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

技能档案

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

典型使用场景

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

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

读仓库与生成改动

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

跑测试与排查故障

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

选择建议

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

值得选的地方

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

先想清楚的地方

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

更适合

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

不太适合

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

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
技能权限级别安装方式累计安装宿主客户端安装命令
project knowledge write当前 未标注权限 未标注 未标注 未标注 有
技能审查员 浏览器控制 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 全文

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

Project Knowledge Writer

将项目源码逐文件分析并写成 Obsidian 风格的知识文档,为项目生成"阅读理解/开发" skill,并按"功能描述"规范处理新增/修改功能。

输入确认

开始前,向用户确认(可合理默认,无需每个都追问):

  1. 文档保存路径 —— 项目分析文档(.md)所在/目标目录。
    - 若位于当前可写工作区之外,需先请求写入授权,授权通过前不要写。
  2. 项目路径 —— 待分析/补充依据的源码根目录。
    - 增量/功能分析模式下必须与用户确认项目路径。
  3. 运行模式 —— 判定见下节:
    - 全量:文档目录为空或不存在既有分析文档。
    - 增量:文档目录已存在本项目分析文档。
  4. 是否生成开发 skill —— 是否生成本项目"阅读理解/开发" skill,及存放目录(默认 $ACODE_HOME/skills)。
  5. 是否需要处理功能描述 —— 是否执行功能分析(默认执行,见阶段三)。
  6. 工具检查 —— 见下节。

运行模式判定

  1. 查看 文档保存路径 下是否已存在本项目分析文档(如 项目总览.md、<模块>/xxx.c.md)。
  2. 存在 → 增量;不存在/为空 → 全量。
  3. 向用户确认项目路径与判定结果后再动手。

工具检查

分析前检查本次任务需要的外部工具是否可用(按需):

  • rg / 系统 grep(或等价的文件检索能力)—— 列文件、搜函数签名/结构体定义、核验 [[]] 链接标题。
  • python3 —— 仅在需要跑脚本/模板(如 skill-creator 的 init_skill.py)。
  • 文档读写与检索能力(文件 read/write/edit、glob、grep)与目标是否 Obsidian 笔记库。
  • 编译/测试工具链(在生成开发 skill 与功能分析验收阶段检查)。

流程:
1. 用 Get-Command/which 或等价方式探测所需命令。
2. 若某项必需工具缺失:先停手,把缺失项和它对本次任务的影响告诉用户,并问"是否自动安装";得到允许再安装,否则给出替代做法后继续。
3. 记录工具检查结论,写进最终报告。

输出规范(核心约定)

  • 每个源文件一篇 .md,命名 <文件名>.md;入口文件用 <文件名>, 应用入口.md。
  • 每篇以 # 文件路径 开头,标注源文件路径。
  • 函数、结构体、枚举、全局变量都单独用一个 # 名称...() 或 # 名称...结构/枚举 标题描述其作用。
  • 引用这些实体的地方一律用 Obsidian 双向链接:跨文件 [[目标文件名#实体标题]]、同文件 [[#实体标题]]。
  • 流程性说明用缩进列表;中文描述。
  • 完整格式与示例见 [[references/conventions.md|文档规范]]。

阶段一·全量:从源码生成分析文档

按"先盘点、后逐模块、再索引"推进:

  1. 盘点范围:列出项目根目录与关键子目录,识别"项目自有代码"vs"基线SDK";与用户确认边界;统计每个模块 .c/.h 数量。
  2. 逐模块分析:每文件先读头文件(结构体/枚举/API),再读 .c 函数清单与关键函数体;预编译库按其对外头文件接口说明。
  3. 生成文档:每个文件一篇 .md(遵循 [[references/conventions.md|文档规范]]),模块子目录镜像源码,写项目总览做索引。
  4. 验收:实体 # 标题完整、[[目标#标题]] 目标标题确实存在(grep 核验)、中文与链接完好、交付文件数符合清单。

阶段一·增量:理解既有文档并补充优化

用于文档保存路径已存在本项目分析文档的场景。不做全量重建:

  1. 理解既有文档:读项目总览与各模块,识别实体 # 标题、规范版本、覆盖范围与空缺。
  2. 确认项目路径(增量下必确认)。
  3. 增量补充:以当前源码为准校准实体标题、[[]] 链接、描述;补齐未覆盖模块/缺失标题/过时描述;必要时更新项目总览。
  4. 验收:与全量相同。

阶段二:生成项目开发 skill(阅读理解)

在分析文档(全量或增量)验收通过后,为项目生成"阅读理解/开发" skill,支持阅读、修改、编译、测试。

  1. 确认工具链:识别构建方式与编译/测试命令、产物路径;探测工具链可用性,缺失项报告并问是否自动安装。
  2. 盘点项目特定信息:项目路径、分析文档路径、入口与关键模块、编译与测试命令、产物与验收。
  3. 按 skill-creator 规范创建 <项目名>-dev(默认 $ACODE_HOME/skills),SKILL.md 按 [[references/reader-skill-template.md|开发 skill 模板]] 填充,写明分析文档路径、编译/测试命令。
  4. 验证:校验新 skill 的 frontmatter/命名(quick_validate.py,其依赖 pyyaml,缺失按工具检查流程处理);确认能定位分析文档与构建/测试命令。

阶段三:功能分析

按 [[references/feature-analysis.md|功能分析规范]] 管理功能描述。

  1. 确保文档根目录下存在 功能描述/ 子目录;若刚创建,先播种两个模板(新增需求的功能模板.md、需要修改的功能模板.md)。
  2. 扫描 功能描述/ 中标注为「新增需求的功能」或「需要修改的功能」的功能文件(排除模板)。
  3. 无待办 → 跳过;有则逐文件:
    - 读该功能文件各段落(需求/修改内容/涉及模块/验收标准);
    - 按其描述实现或修改(结合分析文档与源码);
    - 按验收标准测试(可编译时用开发 skill 的编译/测试流程);
    - 测试通过 → 向用户汇报并提请确认版本号;
    - 用户确认后 → 按生命周期转「现有功能」并写入版本号(新增需求→1.0.0;需要修改→用户确认版本号),内容转为现有功能规范;
    - 测试不通过或需求不明确 → 停下说明并等待,不擅自转现有。
  4. 涉及结构体/枚举/函数签名变更时,同步更新对应分析文档。

资源

  • references/conventions.md —— 项目分析文档的格式规范与示例(阶段一用)。
  • references/reader-skill-template.md —— 项目开发 skill 的 SKILL.md 模板(阶段二用)。
  • references/feature-analysis.md —— 功能描述规范与功能分析流程(阶段三用)。

交付

  • 完成后,报告:
    1. 运行模式、文档保存路径、生成/补充的文件数与模块覆盖、工具与工具检查结论、范围边界与遗留项。
    2. 生成的开发 skill 名称/位置及其编译/测试命令概览。
    3. 功能分析结果:功能描述/ 下识别到的待办、已实现/测试/待用户确认的功能与版本。
  • 若写了工作区临时草稿(.skill_build 等),交付后清理。

常见问题

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

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

project knowledge write支持哪些客户端?

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

project knowledge write权限高吗,安全吗?

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

project knowledge write收费吗?

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

project knowledge write用什么许可证?

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

热门专题

按场景挑技能
全部专题 →

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