lenminh002/project-wiki

# project-wiki — 适用于智能体编码工具的项目维基技能 [](https://skills.sh/lenminh002/project-wiki) 受 Andrej Karpathy 启发，这是一个适用于智能体编码工具的技能，可构建一个项目维基，实现跨会话上下文持久化、自动保存计划、跟踪错误、记录进度以及绘制代码库地图。之后可以通过 Obsidian 将项目可视化为图形，查看各部分之间的联系。 该技能可为**任何智能体编码工具**引导建立一个持久化的项目维基——包括 Codex CLI、Cursor、Claude Code 等： - `wiki/` 文件夹（包含 `CONTEXT.md`、`log.md`、`bugs/`、`plans/`） - 可选的项目本地命令，供未来会话使用：`wiki-help`、`log`、`bug`、`status`、`read` - 将多步计划保存至 `wiki/plans/active/` 以保持连续性 - **AI 自动检测关系** — 智能体会检查现有维基内容，并使用 `[[wikilinks]]` 和标签（`builds-on`、`depends-on`、`replaces` 等）将新计划和错误与相关项链接 - `codemap` 会为源文件生成 `wiki/code/` 条目，包括 HTML/CSS 链接 - 完全兼容 Obsidian — 将 `wiki/` 作为 vault 打开，即可获得图形视图和反向链接面板 ## 安装说明 使用跨智能体的 skills CLI 全局安装此技能： ``` npx skills add lenminh002/project-wiki --skill wiki-init --global ``` 然后在任何受支持的智能体中打开一个项目并运行： ``` /wiki-init ``` 智能体会从非密钥元数据文件中检测项目的名称、技术栈和部署目标，构建 `wiki/` 目录结构，并在将可选的项目本地规则写入 `AGENTS.md` 前征求您的同意。 随时运行 `wiki-help` 可快速查看命令速查表。 对于已有旧版 `# Wiki workflow` 块的现有项目，应重新运行 `/wiki-init` 或手动刷新该块，以获取最新的安全性和 `codemap` 规则。 ## 维基文件夹结构 ``` wiki/ CONTEXT.md — project name, goal, stack, conventions, folder tree log.md — session-by-session log bugs/ open/ — one .md file per open bug (YAML frontmatter + wikilinks) fixed/ — fixed bugs (moved from open/, status: fixed) plans/ active/ — plans in progress (with YAML frontmatter + wikilinks) done/ — completed plans abandoned/ — plans we decided not to pursue code/ — generated code graph files from `codemap` ``` 将 `wiki/` 作为 **Obsidian vault** 打开，即可获得计划图视图和反向链接面板。 ## 技能仓库布局 ``` wiki-init/ SKILL.md templates/ CONTEXT.md log.md rules.md.snippet ``` ## 命令（在 AGENTS.md 规则批准后生效） | 输入以下命令 | 智能体执行的操作 | |---|---| | `wiki-help` | 显示维基命令速查表 | | `log` | 将本次会话摘要追加到 `wiki/log.md` | | `bug` | 在 `wiki/bugs/open/` 中创建一个新文件，支持 frontmatter 和 wikilink | | `status` | 列出活跃计划、最近 5 条日志条目和未关闭的错误 | | `read` | 读取所有维基文件，总结上下文，并询问“我们正在处理什么？” | | `codemap` | 为每个源文件生成一个 `wiki/code/<路径>.md` — 包括文件用途、函数/部分列表，以及导入/链接 wikilinks | ## 代码图（`codemap`） 在任何会话中输入 `codemap`，智能体将： 1. 询问要检查的文件夹 2. 仅遍历指定的文件夹（遵循 `.gitignore`，跳过隐藏文件夹、secrets、`node_modules/`、`dist/` 等） 3. 为每个源文件编写一个 `wiki/code/<镜像路径>.md`，包括 HTML 和 CSS 文件，每个文件包含： - **用途** — 一行总结文件的功能 - **函数 / 部分** — 带有一行描述的项目符号列表 - **导入 / 链接** — 仓库内导入、本地 HTML 链接、本地脚本/样式表/资源、CSS `@import` 和 CSS `url(...)` 会表示为 `[[wikilinks]]`；第三方导入/CDN 表示为 `external: package-name` 将 `wiki/` 作为 Obsidian vault 打开，图视图会将您的**整个代码库显示为依赖关系图** — 源文件作为节点，导入和本地链接作为边 — 与您的计划和错误节点并列显示。 可随时重新运行 `codemap` 进行刷新。当智能体编辑一个已拥有 `wiki/code/` 条目的源文件时，它会保持该条目为最新状态。 ## 计划规则 - 任何包含 3 个或更多步骤的计划都会保存至 `wiki/plans/active/<功能名>.md` - 计划会包含 YAML frontmatter：`status`、`created`、`updated`、`tags`、`related` - **智能体会检查现有计划和错误**，检测语义关系，并添加 wikilinks - 关系标签（`builds-on`、`depends-on`、`replaces`、`related-to`）会根据内容和上下文自动推断 - 将计划移至 `done/` 或 `abandoned/` 会更新其 `status:` frontmatter；wikilinks 在移动后保持不变 - 智能体在移动已完成的计划前会征求同意。 ## 卸载说明 删除 `AGENTS.md` 文件（或从中移除 `# Wiki Bootstrap Rule` / `# Wiki workflow` 块），并从项目中删除 `wiki/` 文件夹。 如果您使用 `npx skills add` 安装了持久化触发器，请使用您的 skills CLI 或智能体的技能目录来移除全局的 `wiki-init` 技能。 ``` npx skills remove wiki-init --global ```

标签：AI辅助, bug跟踪, Linux 内核安全, Markdown文档, Obsidian集成, SOC Prime, wiki系统, 上下文持久化, 代理编码工具, 代码库可视化, 代码映射, 会话持久化, 关系检测, 图表可视化, 开发工具, 数据管道, 文档自动化, 标签系统, 知识管理, 编码助手, 计划管理, 计划自动保存, 软件工程, 进度日志, 防御加固, 项目wiki, 项目管理