名称: claude-project-manifest 描述: 为Claude项目创建注释性书目风格清单，跟踪文件、对话线程和关系，使用唯一ID和注释。用于记录项目内容、创建文件清单、跟踪对话历史或构建可导航知识地图。许可证: MIT 复杂度: 中级学习时间: 30分钟标签: [文档, 清单, 注释, 书目, 知识管理]

Claude项目清单

创建结构化、注释性的Claude项目文档，跟踪文件、对话线程及其关系。

使用时机

记录项目内容和结构
创建带注释的文件清单
跨会话跟踪对话历史
构建可导航知识地图
为新协作者介绍现有项目

核心概念

清单结构

清单有四个主要部分：

元数据: 项目级信息（ID、版本、状态）
文件: 带注释的文件清单及来源
线程: 对话摘要和成就
关系: 实体间的依赖和连接

ID系统

实体	格式	示例
项目	`PROJ-{年}-{序列}`	`PROJ-2024-001`
文件	`FILE-{序列}`	`FILE-042`
线程	`THR-{序列}`	`THR-017`
关系	`REL-{序列}`	`REL-123`

快速开始

最小清单

manifest:
  id: "PROJ-2024-001"
  version: "1.0.0"
  created: "2024-01-15T10:30:00Z"

  project:
    name: "我的项目"
    description: "项目的简要描述"
    status: active

files:
  - id: "FILE-001"
    path: "src/main.py"
    title: "主要入口点"
    summary: "应用程序入口和初始化"

完整文件条目

files:
  - id: "FILE-001"
    path: "src/main.py"
    type: source  # source | config | doc | asset | generated
    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"

线程条目

threads:
  - id: "THR-001"
    started: "2024-01-15T10:30:00Z"
    ended: "2024-01-15T12:45:00Z"
    title: "初始项目设置"
    summary: "创建核心基础设施和配置"
    accomplishments:
      - "创建目录结构"
      - "实现带验证的配置类"
      - "添加日志基础设施"
    files_created: ["FILE-001", "FILE-002"]
    files_modified: []
    decisions:
      - "选择YAML而非JSON以提高配置可读性"
      - "使用数据类而非Pydantic以简化"
    tags: [设置, 基础设施]

关系

relations:
  - id: "REL-001"
    type: depends_on
    source: "FILE-001"
    target: "FILE-002"
    annotation: "主要导入并使用配置类"

  - id: "REL-002"
    type: implements
    source: "FILE-003"
    target: "FILE-004"
    annotation: "存储库实现存储接口"

关系类型：

depends_on: 源依赖目标以运行
extends: 源扩展目标
implements: 源实现在目标中定义的接口
references: 源引用目标而无硬依赖
supersedes: 源替代目标（用于版本控制）

编写注释

文件注释

良好注释回答：

什么: 该文件做什么？
为什么: 为什么选择这种方法？
如何: 关键实现细节
上下文: 什么促使其创建？

示例：

notes: |
  使用令牌桶算法实现速率限制。
  选择令牌桶而非滑动窗口以更好处理突发流量。
  在THR-003期间创建，当API过载问题出现时。
  待办：添加Redis后端以分布式速率限制。

线程注释

捕获：

目标: 我们设定要完成的任务
结果: 我们实际实现的内容
决策: 做出的关键选择及理由
工件: 创建或修改的文件

工作流程

开始新项目

创建清单文件（manifest.yaml）
添加项目元数据
设置初始状态为active

开发期间

对话发生时记录新线程
创建文件时添加带注释的文件
依赖形成时记录关系
更新线程成就

项目交接

审查所有线程摘要
验证文件注释为最新
确认所有关系已文档化
如需要，导出到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 — 集成模式

Claude项目清单系统 claude-project-manifest