可持续项目目录
先识别项目类型和真实工作流,再决定目录;不要把某个项目的编号或文档模板机械复制到所有项目。本 Skill 是整理时使用的外部工具,不复制或安装到目标项目。长期维护知识写入该项目的 AGENTS / CLAUDE、docs 与可独立运行的检查工具。
工作流程
- 读取当前目录及适用的
AGENTS.md、CLAUDE.md、README、部署脚本和现有 Skill 说明。 - 按任务范围盘点目录、文档主题和入链、生成器及机器读取的文档字段、未完成项和恢复资料。先确定谁维护什么,再判断重叠和失效;只有需要移动时才扩展到部署、运行引用和旧会话路径。
- 将项目判定为以下一种:
-development:网页、软件、API、自动化工具等持续开发项目。
-research:企划、调查、分析、会议、资料与交付物为主的项目。
-hybrid:企划/分析项目中包含独立开发子项目,或开发项目中包含较大的研究工作流。 - 优先沿用既有责任边界,文档随页面、模块或工作流保存。只为无法承接的长期职责新增根目录;有实际移动才维护迁移表,编号可选。
- 涉及文档整理时执行下面的文档工作流;涉及结构时补齐必要的治理说明和临时生命周期,避免为一次性小改动生成整套制度文件。真正持续复用的项目专属工作流才考虑项目 Skill。
- 更新所有受影响的源码引用、测试、部署白名单、说明文件和 Skill 相对路径。
- 运行结构检查和项目原有测试;确认旧路径可由迁移索引直接找到当前最终路径。
按项目类型选择规则
- 开发项目:完整读取 development-projects.md。让每个页面或可独立维护模块拥有一个所有者目录;按实际复杂度覆盖操作、现行规格和重要变更职责,复用既有名称,不强制每个模块拥有三份文件。
- 企划/调查/分析项目:完整读取 research-projects.md。按工作流、事实来源、会议、交付物和复用资产划分;固定分区和多文件主题维护 README,不默认创建 SPEC 或 CHANGELOG。
- 混合项目:同时读取上述两份参考。根项目使用主工作流的结构,独立开发子目录内部使用开发项目规则,避免把源码、研究原始资料和交付物混在同一层。
- 整理已有项目或移动路径:额外完整读取 migration-and-governance.md。
文档工作流
先完整读取 documentation-lifecycle.md。目录导航和内容治理一起完成:
- 按主题确定唯一现行来源,区分长时效指南、当前任务、短时效记录和历史资料。根入口只导航长期入口与模块;短期记录留在所属模块。
- 对重叠正文实际比较并合并:保留独有约束、结论、证据、未完成项及恢复价值;冲突核对实现与证据,不以日期新旧决定真伪。
- 将稳定方法写回长期来源,将完成批次从当前任务中移出;旧记录标明适用时间与替代入口,已有历史位置无需按年龄重复搬迁。
- 从实际路径和标题生成目录,优先扩展现有工具。只读检查发现过期,写入模式只更新标记区;不维护第二份逐文件清单,也不要求所有短期文档从根可达。
- 在适用
AGENTS.md/CLAUDE.md写入唯一文档规则入口及实际生成、检查命令;文档新增、删除、重命名或标题变化后在同一任务收尾运行并审查差异。自动生成不等于已安装后台监听或 CI。 - 验证内容去重、相对入链/出链、机器消费者、生成幂等性和过期检测。报告实际归并与保留项,不把“链接都有效”当成知识已更新。
新项目快速搭建
以下编号布局是可选的新项目模板。已有项目先按其约定治理,不用模板审计结果强迫迁移。脚本默认只预览,不覆盖已有文件:
python3 scripts/scaffold_project.py init \
--root /path/to/project \
--name ExampleProject \
--profile development \
--unit 01_Account \
--unit 10_Service \
--agent codex
python3 scripts/scaffold_project.py init \
--root /path/to/project \
--name ExampleProject \
--profile development \
--unit 01_Account \
--unit 10_Service \
--agent codex \
--apply
企划/分析项目把 --profile 改为 research。项目已存在内容时,先人工盘点,再明确添加 --allow-existing;该参数只允许补齐缺失文件,仍不会覆盖文件。
脚手架默认不创建、不要求项目 Skill 目录。只有确有长期项目专属工作流时,才用 --skill-dir 显式选择既有或合适的位置;这不用于安装本通用治理 Skill。生成的项目规则和目录工具在本 Skill 不可用时仍须能维护项目。
审计
python3 scripts/scaffold_project.py audit \
--root /path/to/project \
--profile development \
--unit 01_Account \
--unit 10_Service
此命令只审计所选脚手架基线,不是任意仓库的合规标准。按实际受影响范围补做:
- 搜索旧路径和新路径的硬编码引用。
- 验证部署清单中每个本地源文件存在。
- 检查每个项目 Skill 的
SKILL.md、agents/、references/、scripts/、assets/相对路径。 - 清理本次产生且不再需要的临时产物;既有文件须先确认用途、归属与恢复价值。
- 保留有价值的过程资料,但放入页面历史、主题目录、复用资产或归档区。
关键约束
- 遵循项目已有目录与授权边界;已获授权的整理直接完成,实际高风险或不可逆操作需明确范围。不要为常规可逆整理另设审批门槛。
- 根目录治理说明记录真实职责和变更规则;需要严格白名单的项目才增加对应检查。
- 迁移索引只记录移动、重命名和被替代的旧路径;新建文件不登记,日常任务不预读。
- 迁移表中的目标必须是当前最终路径,不能要求旧会话连续跳转多次。
- 临时目录必须有任务级生命周期;最终交付物和 Skill 权威源不得只留在临时区。
- 可复用资产先经过实际任务验证;触发条件、工作流和安全边界稳定后再形成 Skill。
- Skill 不依赖临时目录、个人敏感文件、实时凭据或仅存在于另一台机器的路径。
- 目录整理不应擅自改变线上 URL、API 路由、部署目标、权限语义或数据位置。