From 1745db81541e94200309dc2136ff15ce4349fa3f Mon Sep 17 00:00:00 2001 From: ila Date: Sat, 8 Aug 2026 08:56:31 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=BB=BA=E7=AB=8B=E6=96=B0=E9=A1=B9?= =?UTF-8?q?=E7=9B=AE=E6=96=87=E6=A1=A3=E5=88=9D=E5=A7=8B=E5=8C=96=E6=8C=87?= =?UTF-8?q?=E5=8D=97=20(#2)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- New-Project-Documentation-Setup.-.md | 91 ++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 New-Project-Documentation-Setup.-.md diff --git a/New-Project-Documentation-Setup.-.md b/New-Project-Documentation-Setup.-.md new file mode 100644 index 0000000..d96a571 --- /dev/null +++ b/New-Project-Documentation-Setup.-.md @@ -0,0 +1,91 @@ +# 新项目文档初始化 + +## 本页用途 + +从 DevHarness 创建新项目时,指导 Claude/Codex Agent快速建立可供初级程序员阅读的项目文档。初始化只生成可靠的第一版,不允许 Agent 臆造业务规则、凭据、部署环境或生产数据。 + +## 初始化顺序 + +### 1. 建立项目边界 + +由项目负责人确认: + +- 项目名称和一句话目标; +- 用户和主要使用场景; +- 技术栈和支持环境; +- Gitea 仓库、默认分支和维护者; +- 安全、权限、数据和发布红线。 + +把项目专用红线写入根目录或子目录 `AGENTS.md`。 + +### 2. 建立 Gitea + +创建远端仓库并完成允许的初始引导提交。开启工单和 Wiki。任何产品功能开发在引导提交后都必须先有单元任务工单。 + +### 3. 修改镜像配置 + +把 `wiki-docs.json` 中的地址、owner 和 repository 改成新项目。移除属于 DevHarness 自身的任务归档映射;核心主题映射保留。 + +不要把 PAT 写入配置。 + +### 4. Agent 检查项目事实 + +Agent 只读检查: + +- README、配置和依赖文件; +- 启动入口; +- 主要模块和目录规则; +- 测试、格式和静态检查命令; +- 日志、示例配置和测试数据; +- 已存在的接口、数据模型和状态。 + +区分“代码中确认的事实”“负责人确认的业务规则”和“仍待确认的假设”。 + +### 5. 先创建线上 Wiki + +至少创建或填写: + +1. Home; +2. Project-Profile; +3. Architecture-and-Code-Map; +4. Business-Rules-and-Glossary; +5. Local-Development-and-Verification; +6. Common-Changes; +7. Troubleshooting; +8. Development-Workflow; +9. Task-Archive-Template。 + +Home 给出建议阅读顺序;每个命令必须有预期结果;代码地图必须指出入口和测试位置。 + +### 6. 人工确认 + +项目负责人至少确认: + +- 一句话目标和业务术语; +- 关键业务规则和状态; +- 权限、安全和数据边界; +- 真实运行、测试和部署命令; +- 哪些修改属于高风险。 + +### 7. 导出镜像并检查 + +```powershell +python scripts/sync_wiki_docs.py +python scripts/check_harness.py --strict +python scripts/sync_wiki_docs.py --check +python -m unittest discover -s tests -v +``` + +只有线上 Wiki 确认后才导出 `docs/`。旧项目的任务归档不能带入新项目历史。 + +## 完成标准 + +初级程序员应能仅依靠 Home 和链接页面回答: + +- 项目解决什么问题; +- 怎样启动和运行测试; +- 常用功能从哪个目录和入口开始读; +- 一个简单修改通常要改哪里、验证什么; +- 哪些情况必须停止并交给 Agent 或负责人。 + +回答不了的问题应继续补充主题文档,而不是堆入任务归档。