跳到主要内容

项目 README 模板

新项目首份 README 套用本模板。目标长度 80 行左右(超过 120 行 verify:kb 会出 soft warning,提示减肥)。

使用前置

下笔前读完三份:

  1. 本仓根 Agent 入口约定
  2. 接入指南
  3. 本项目所属 maturity 阶段在 项目目录组织 表里的位置

模板骨架

下面整段复制到 projects/<id>/README.md,按尖括号注释填写。表格中的「链接到 X」行在套用时替换为指向真实文档的 markdown 链接(方括号包人可读名称,圆括号包相对路径):

---
title: <项目名>
status: active | draft | reserved
last-updated: YYYY-MM-DD
scope: project/<project-id>
maturity: active | draft | deprecated
---

# <项目名>

<一句话定义:是什么 / 给谁用 / 解决什么问题 / 关键边界。本段不超过 3 行>

> 关键边界:<本项目不做什么;与其它项目 / 对象的角色不重叠点>。

## 一页说明(M1+ 项目可选)

<一段约 150 字的定位 + 黄金路径概述,让冷启动读者 3 分钟看懂"是什么、不是什么"。
预启动项目(rle / fefm 这一档)可跳过本段,直接进文档结构>

## 当前状态

|| 状态 |
| --- | --- |
| 阶段 | <对应 ecosystem 当前基线的阶段标记> |
| 第一阶段验收 | <最低验收字段中的关键 1-2 > |
| 当前进行中 | <本周 / 本月正在做的工作> |
| 已知 gap | <未决问题,1-3 > |

## 阅读路径

<给人 / 团队的阅读顺序。表格形式,最多 4 行>

| 你想做什么 | 打开哪份 |
| --- | --- |
| 快速理解项目当前定位 | 本页 |
| 看完整战略基线 | 链接到战略白皮书 |
| 看 V1 / 当前阶段产品规格 | 链接到产品规格 |
| 接入实施 | 链接到执行计划 |

## 文档分层

### 主文档(人读)

| 文档 | 用途 |
| --- | --- |
| 链接到文档 A | <一句话用途> |

### 归档 / 历史输入(可选)

<旧版本、超期、被取代的文档。归档到 `_archive/` 后在本节留索引>

### Agent 派生入口

Agent 不从人读文档自由推断执行合同。低上下文读取顺序、机器约束、gate 由 `for-agents/projects/<id>/` 派生包承载(不在公开站点;通过仓库直接访问)。

## 与其他目录的关系

| 目录 | 关系 |
| --- | --- |
| `ecosystem/` | 继承生态级口径 |
| `commons/` | 借用方法论 / 模板 / 参考 |
| `<id> 工程仓` | 工程化执行 artifact 本体(不在本仓) |

## 相关协同

| 类型 | 入口 |
| --- | --- |
| 跨项目同步 | <handoff-anchor 路径或工程仓位置(角色化描述,不写绝对路径)> |
| 升级请求 | 链接到 governance/escalation.md |
| 接入规则 | 链接到 ACCESS.md |
| 仓库总入口 | 链接到 README.md |

字段填写指引

  • status:当前 README 自身的发布状态。active = 已对齐当前基线;draft = 构建中;reserved = 占位。
  • maturity:项目整体成熟度。对照 ecosystem 当前基线取值。
  • last-updated:每次显著修改更新。
  • scope:固定 project/<project-id>

反模式(别这么写)

  • ❌ 一句话定义写 5 行(超长定义 = 没定义)
  • ❌ 阅读路径表 > 5 行(说明缺少入口分层)
  • ❌ 把工程仓的执行 artifact 直接搬进 README(属于工程仓的事)
  • ❌ 在文档分层里用 ../../foo.md 作为链接显示文本(违反 ACCESS.md §4)
  • ❌ 用本地绝对路径指代任何文件 / 目录