docs: 统一 Agent 中英文交流规范 (#31)
This commit is contained in:
@@ -6,6 +6,12 @@
|
||||
|
||||
[项目档案](docs/00-project-profile.md) 按需阅读,不作为每次任务的固定前置。首次接手项目、治理模式不清楚,或出现下列情况之一时必须读:需要环境、配置或凭据来源;需要确认目录边界;需要判断子项目与交付单元划分;需要 DevHarness 来源与基线;需要项目专用验收要求。同一会话已经确认且没有变化时不重复读取;只为查命令不必打开项目档案。
|
||||
|
||||
## 语言与术语
|
||||
|
||||
- 用户可以使用中文、英文或合理的中英混合语言交流;默认使用中文分析、回复、编写工单和维护内部项目文档。
|
||||
- 代码标识符、命令、参数、路径、文件名、API 名称、协议名、日志和错误原文保持原样;合理的英文术语可以保留,必要时首次出现补充简短中文解释。
|
||||
- 用户明确要求某次回复或交付物使用其他语言时,按该次要求执行;不得为了语言统一改写事实、接口契约或影响搜索和执行的原文。
|
||||
|
||||
## 常用命令
|
||||
|
||||
所有命令默认从仓库根目录执行,与项目档案保持一致。
|
||||
|
||||
@@ -77,6 +77,7 @@ CORE_DOCUMENT_REQUIREMENTS = {
|
||||
"## 环境、配置与凭据",
|
||||
),
|
||||
"docs/01-workflow.md": (
|
||||
"## 语言与术语",
|
||||
"## Gitea 交互与工单最小读取",
|
||||
"## 新项目 Wiki 初始化门禁",
|
||||
"## 按治理模式选择最小门禁",
|
||||
@@ -353,6 +354,10 @@ def check_agent_efficiency_rules(errors: list[str], root: Path = ROOT) -> None:
|
||||
"### 按治理模式选择最小设计证据",
|
||||
"轻量模式的小 Bug、局部样式或布局",
|
||||
"明确为虚构的测试数据无需形式化脱敏",
|
||||
"用户可以使用中文、英文或合理的中英混合语言交流",
|
||||
"默认使用中文分析、回复、编写工单和维护内部项目文档",
|
||||
"日志和错误原文保持原样",
|
||||
"按该次要求执行",
|
||||
"完整独立需求、新页面、重大交互或导航变化",
|
||||
"`prototypes/<工单号>/<版本>/index.html`",
|
||||
"默认直接通过 Quant-UX 或其他设计工具的线上链接审核",
|
||||
|
||||
+11
-2
@@ -2,8 +2,8 @@
|
||||
generated: true (请先修改 Gitea Wiki,禁止直接编辑本文件)
|
||||
wiki_page: Development-Workflow
|
||||
wiki_url: https://git.ilapage.cn/OPC/dev_harness/wiki/Development-Workflow.-
|
||||
wiki_revision: b82dc79b2d74b83c4e255600beceb7c1e292c9a4
|
||||
synchronized_at: 2026-09-02T02:13:59Z
|
||||
wiki_revision: 3f420edaa937aaef3dbfe31b756ab6459ca5ce81
|
||||
synchronized_at: 2026-09-02T07:09:09Z
|
||||
<!-- gitea-wiki-mirror:end -->
|
||||
|
||||
# 开发工作流
|
||||
@@ -15,6 +15,15 @@ synchronized_at: 2026-09-02T02:13:59Z
|
||||
- Git 保存源码、与特定代码版本强绑定的文档,以及 Wiki 的本地镜像。
|
||||
- 本地 `docs/` 仅供浏览和审查,不是长期文档编辑入口。
|
||||
|
||||
## 语言与术语
|
||||
|
||||
- 用户可以使用中文、英文或合理的中英混合语言提出需求和补充信息;Agent 不要求用户先翻译。
|
||||
- Agent 默认使用中文进行分析、回复、工单记录和内部项目文档维护。
|
||||
- 代码标识符、命令、参数、路径、文件名、API 名称、协议名、日志和错误原文保持原样,不做会影响搜索、复制、执行或排错的翻译。
|
||||
- commit、revision、middleware 等通用英文术语可以保留;可能影响初级维护者理解时,在首次出现处补充简短中文解释,不反复注释。
|
||||
- 用户明确要求某次回复、交付物或对外文档使用其他语言时,按该次明确要求执行;默认中文不是禁止其他交付语言的门禁。
|
||||
- 引用外部材料时保留必要原文并用中文说明结论;不得为了语言统一改写事实、错误信息或接口契约。
|
||||
|
||||
## Gitea 交互与工单最小读取
|
||||
|
||||
- 所有 Gitea 工单和 Wiki 的查询、创建、更新、评论、状态变更及关闭操作,优先使用项目已配置的 Gitea MCP。
|
||||
|
||||
@@ -108,6 +108,16 @@ class CoreDocumentTests(unittest.TestCase):
|
||||
check_agent_efficiency_rules(errors)
|
||||
self.assertEqual(errors, [])
|
||||
|
||||
def test_agents_and_workflow_share_language_policy(self) -> None:
|
||||
agents = (ROOT / "AGENTS.md").read_text(encoding="utf-8")
|
||||
workflow = (ROOT / "docs/01-workflow.md").read_text(encoding="utf-8")
|
||||
for text in (agents, workflow):
|
||||
self.assertIn("中文", text)
|
||||
self.assertIn("英文", text)
|
||||
self.assertIn("默认使用中文", text)
|
||||
self.assertIn("错误原文保持原样", text)
|
||||
self.assertIn("按该次", text)
|
||||
|
||||
def test_existing_project_adoption_requires_upgrade_process(self) -> None:
|
||||
required = CORE_DOCUMENT_REQUIREMENTS[
|
||||
"docs/08-existing-project-adoption.md"
|
||||
|
||||
Reference in New Issue
Block a user