名称:claude-project-manifest 描述:为Claude项目创建带注释的书目风格清单,跟踪文件、对话线程及其关系,使用唯一ID和注释。用于记录项目内容、创建文件清单、跟踪对话历史或构建可导航的知识地图。 许可证:MIT 复杂度:中等 学习时间:30分钟 标签:[文档,清单,注释,书目,知识管理]
Claude项目清单
创建结构化、带注释的Claude项目文档,以跟踪文件、对话线程及其关系。
何时使用
- 记录项目内容和结构
- 创建带注释的文件清单
- 跟踪跨会话的对话历史
- 构建可导航的知识地图
- 让新协作者快速了解现有项目
核心概念
清单结构
清单有四个主要部分:
- 元数据:项目级信息(ID、版本、状态)
- 文件:带注释的文件清单,包括来源
- 线程:对话摘要和成就
- 关系:实体之间的依赖和连接
ID系统
| 实体 | 格式 | 示例 |
|---|---|---|
| 项目 | PROJ-{年}-{序列} |
PROJ-2024-001 |
| 文件 | FILE-{序列} |
FILE-042 |
| 线程 | THR-{序列} |
THR-017 |
| 关系 | REL-{序列} |
REL-123 |
快速开始
最小清单
清单:
id: "PROJ-2024-001"
version: "1.0.0"
created: "2024-01-15T10:30:00Z"
项目:
name: "我的项目"
description: "项目的简要描述"
status: 活跃
文件:
- id: "FILE-001"
path: "src/main.py"
title: "主入口点"
summary: "应用程序入口和初始化"
完整文件条目
文件:
- id: "FILE-001"
path: "src/main.py"
type: source # 源码 | 配置 | 文档 | 资源 | 生成
thread_id: "THR-001"
title: "主入口点"
summary: "目的的单行描述"
notes: |
扩展注释解释:
- 做出的设计决策
- 选择此方法的原因
- 关键实现细节
- 已知限制或待办事项
tags: [核心,初始化]
depends_on: ["FILE-002", "FILE-003"]
created: "2024-01-15T10:30:00Z"
modified: "2024-01-16T14:20:00Z"
线程条目
线程:
- id: "THR-001"
started: "2024-01-15T10:30:00Z"
ended: "2024-01-15T12:45:00Z"
title: "初始项目设置"
summary: "创建了核心基础设施和配置"
accomplishments:
- "创建了目录结构"
- "实现了带验证的Config类"
- "添加了日志基础设施"
files_created: ["FILE-001", "FILE-002"]
files_modified: []
decisions:
- "选择YAML而非JSON以提高配置可读性"
- "使用dataclasses而非Pydantic以简化"
tags: [设置,基础设施]
关系
关系:
- id: "REL-001"
type: depends_on
source: "FILE-001"
target: "FILE-002"
annotation: "主文件导入并使用Config类"
- id: "REL-002"
type: implements
source: "FILE-003"
target: "FILE-004"
annotation: "Repository实现StorageInterface"
关系类型:
depends_on:源依赖于目标才能运行extends:源在目标基础上构建implements:源实现在目标中定义的接口references:源引用目标但没有硬依赖supersedes:源替换目标(用于版本控制)
编写注释
文件注释
好的注释回答:
- 什么:这个文件做什么?
- 为什么:为什么选择这种方法?
- 如何:关键实现细节
- 上下文:什么促使了它的创建?
示例:
notes: |
使用令牌桶算法实现速率限制。
选择令牌桶而非滑动窗口以更好地处理突发流量。
在THR-003期间创建,当出现API过载问题时。
待办:添加Redis后端以支持分布式速率限制。
线程注释
捕获:
- 目标:我们旨在实现什么
- 结果:我们实际实现了什么
- 决策:做出的关键选择和理由
- 产物:创建或修改的文件
工作流程
开始新项目
- 创建清单文件(
manifest.yaml) - 添加项目元数据
- 设置初始状态为
活跃
开发期间
- 当对话发生时记录新线程
- 创建文件时添加带注释的文件
- 形成依赖时记录关系
- 更新线程成就
项目移交
- 审查所有线程摘要
- 验证文件注释是最新的
- 确认所有关系都已记录
- 如果需要,导出为Markdown报告
输出格式
YAML(主要)
最适合编辑和版本控制。参见assets/templates/manifest.yaml。
JSON(机器可读)
用于程序化访问。参见assets/templates/manifest.json。
Markdown报告
人类可读的导出,用于文档。参见assets/templates/manifest-report.md。
参考
references/manifest-schema.md— 完整模式规范references/annotation-guidelines.md— 编写有效注释的指南references/id-systems.md— ID生成策略references/workflow-integration.md— 集成模式
相关技能
- knowledge-graph-builder:用于更复杂的关系建模
- documentation-generator:用于从清单生成文档