文档更新¶

将文档与代码库同步，并从原始源文件中生成。

第 1 步：识别原始源¶

第 2 步：生成脚本参考¶

1. 读取 package.json（或 Makefile、Cargo.toml、pyproject.toml）
2. 提取所有脚本/命令及其说明
3. 生成参考表：

| 커맨드 | 설명 |
|--------|------|
| `npm run dev` | hot reload로 개발 서버 시작 |
| `npm run build` | 타입 체크 포함 프로덕션 빌드 |
| `npm test` | 커버리지 포함 테스트 스위트 실행 |

第 3 步：生成环境变量文档¶

1. 读取 .env.example（或 .env.template、.env.sample）
2. 提取所有变量及其用途
3. 将变量分类为必需项与可选项
4. 记录预期格式和有效值

| 변수 | 필수 | 설명 | 예시 |
|------|------|------|------|
| `DATABASE_URL` | 예 | PostgreSQL 연결 문자열 | `postgres://user:pass@host:5432/db` |
| `LOG_LEVEL` | 아니오 | 로깅 상세도 (기본값: info) | `debug`, `info`, `warn`, `error` |

第 4 步：更新贡献指南¶

创建或更新 docs/CONTRIBUTING.md： - 开发环境设置（前置要求、安装步骤） - 可用的脚本及其用途 - 测试流程（如何运行、如何编写新测试） - 代码风格规范（linter、formatter、pre-commit hook） - PR 提交清单

第 5 步：更新运维手册¶

创建或更新 docs/RUNBOOK.md： - 部署流程（分步骤） - 健康检查端点及监控 - 常见问题及解决方法 - 回滚流程 - 通知与升级路径

第 6 步：检查过期条目¶

1. 查找超过 90 天未修改的文档文件
2. 与最近的源代码更改进行交叉对照
3. 将可能过期的文档标记为待手动审查

第 7 步：显示摘要¶

문서 업데이트
──────────────────────────────
업데이트: docs/CONTRIBUTING.md (스크립트 테이블)
업데이트: docs/ENV.md (새 변수 3개)
플래그:   docs/DEPLOY.md (142일 경과)
건너뜀:   docs/API.md (변경 사항 없음)
──────────────────────────────

规则¶

• 单一来源：始终从代码生成，不要手动编辑已生成的部分
• 保留手动部分：仅更新生成的部分；手写内容保持不变
• 标记生成内容：在生成的部分周围使用 <!-- AUTO-GENERATED --> 标记
• 未经请求不生成文档：仅在命令明确要求时创建新的文档文件