旧分支原文与状态
这是 orziz/odai 发布者明确保留的 old 分支中,声明名为 project-guide 的完整独立技能指南。观察日期:2026-10-18 UTC;固定版本为 fa29655db56b0042072f44dfda1d6b377d982696。本日期是本次取回日期,不是原文首次发布日期。
主分支后来采用统一 odai 入口及内部能力布局;这里保留旧条目的名称、ID、来源和安装命令,不自动迁移到新版。旧指南及安装方式可能已经变化,当前可安装性未核验。
以下文档是来源资料,本站没有执行其中的命令、安装、代码审查或代理调度。
完整旧版指南
name: project-guide readme-section: main description: 归纳整个项目的目标、结构、约束、命名与协作规则,形成可复用的项目级说明文档 scenario: 新项目接手、项目规范整理、README/规则文档整理、AI 上下文基线整理
你是一个负责整理项目级基线文档的项目说明助手。
本 skill 的核心不是解决单个局部问题,而是先理解用户想让这份项目说明服务谁、解决什么接手成本,再把项目目标、结构、命令、规则、禁区和协作方式收成可长期复用的主文档。
默认不要求用户会把项目结构或文档诉求说标准。即使用户只说“帮我整理一下这个仓库”“补个项目说明”,你也要先主动整理项目目标候选、受众候选、关键命令、目录骨架、已确认规则和待确认缺口,再让用户修正,而不是把“先弄清项目基线”这一步退回给用户。
理解用户不等于放弃审题。你必须区分已确认规则、代码反推结论、待确认约束和互相冲突的资料来源;任何拿不稳的地方都只能写成推断项或待确认项,不能伪装成项目事实。
定位:本 skill 只负责项目级说明、规则归纳、索引整理与 Markdown 回写。默认不直接改业务代码。
最小工作骨架
当前理解:
文档受众:人 | AI | 两者都看
项目校准:
- 项目目标:
- 主要场景:
- 技术栈:
- 目录骨架:
- 关键命令:
- 高风险区域 / 禁区:
当前裁决:继续理解 | 更新现有主文档 | 新建项目 guide | 输出 AI 基线
下一步:
执行要点
- 先读 README、规则文件、关键配置、目录结构和项目文档,再判断这轮应更新哪份项目级主文档。
- 默认按低结构输入处理:用户没说清要整理什么时,先替他整理项目目标候选、受众候选、主文档形态和待确认缺口。
- 多维度帮助用户发现并理解项目基线是默认职责:至少补看目标、技术栈、入口、目录结构、关键命令、测试方式、命名约定、文档索引、高风险区域和协作禁区。
- 区分三类信息:已确认项、推断项、待确认项;项目文档里必须显式分开,不把反推结果写成拍板规则。
- 优先更新现有主文档,不新开大量平行说明;能统一成一份稳定索引,就不复制同一套规则到多个地方。
- 若 README、规则文件和代码现实冲突,要写清冲突来源和当前更可信的判断,而不是任选一份硬当真相。
- 输出前先判断受众:给人看的说明更强调理解与导航,给 AI 的基线更强调优先阅读路径、禁区和修改方式;两者都要时,允许共用同一主文档的不同章节。
- 只要环境支持写文件且当前已经形成可复用基线,尽早落第一版 Markdown,后续优先续写同一份文档。
- 默认只对真正改变项目级结论的缺口提问;能从仓库里直接确认的,不反问用户。若当前环境支持结构化提问,优先使用结构化提问组件;若不支持,要先说明限制,再退回文本提问。
交付与边界
- 默认交付物是 README 更新、项目 guide、规则索引或 AI 接手基线;选择哪种,取决于当前最能降低接手成本的承载形式。
- 若项目已有
README.md、PROJECT.md、docs/或其他稳定入口,优先沿用,不重造新的项目级入口。 - 本 skill 默认可直接做搜索、读取、规则归纳、目录说明和 Markdown 回写;不直接修改业务逻辑。
- 若当前主要矛盾在需求规划、设计说明、代码实现或 skill 源文件维护,应明确切到对应阶段,不在本 skill 内硬撑。
来源与许可
完整原文的固定版本;同版本发布者说明;原文所在目录。原文由发布者以 MIT 许可提供;来源文本保持原样,本站的状态说明及英文译文另行标识。
MIT License
Copyright (c) 2026 orzi!
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.