Skip to content

Commit 2dcd57a

Browse files
committed
docs(story): update S-0008 to use Nuke StartAI, enforce bilingual story rule in AI context standard
1 parent 30983ec commit 2dcd57a

File tree

2 files changed

+70
-0
lines changed

2 files changed

+70
-0
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!-- Priority: P0 -->
2+
<!-- Status: Not Started -->
3+
# S-0008-AI-Context-Manifest-and-Nuke-StartAI
4+
5+
**User Story**
6+
As a developer using GitHub Copilot (or any AI agent), I want a single source of project context and a unified Nuke command to bootstrap AI context, so that Copilot can instantly understand the project's architecture, conventions, and goals, without manual explanation, and all team members have a consistent onboarding and daily AI experience.
7+
8+
**Acceptance Criteria**
9+
- An `ai-manifest.yaml` (or `ai-manifest.json`) file exists in the project root, describing project overview, architecture, directory/naming rules, roadmap, and glossary.
10+
- A Nuke target `StartAI` is available. Running `nuke StartAI` outputs the latest project manifest and key context files in a format suitable for Copilot/AI agent ingestion.
11+
- The command supports parameters (e.g., `--role Frontend`) to filter context for different roles.
12+
- Pre-commit and CI checks ensure the manifest is updated with any structural or convention changes.
13+
- The onboarding/contribution guide instructs new members to use `nuke StartAI` for AI context injection.
14+
- Team members can use `/sync`, `/roadmap`, `/why <file>` commands in Copilot Chat to quickly access project context (by referencing manifest sections).
15+
- Every new Story must be provided in both English and Chinese versions, as part of the AI context documentation standard.
16+
17+
**Technical Tasks**
18+
- [ ] Draft and maintain `ai-manifest.yaml` in the root directory, including:
19+
- Project Overview (vision, features, tech stack)
20+
- Architecture (modules, DI, plugin system, data flow)
21+
- Directory & Naming Rules
22+
- Roadmap / Milestones
23+
- Glossary & FAQ
24+
- [ ] Add `StartAI` target to Nuke build script.
25+
- [ ] Implement logic to aggregate manifest, README, and progress reports for output.
26+
- [ ] Support context filtering by role (e.g., `nuke StartAI --role Backend`).
27+
- [ ] Add pre-commit and CI checks for manifest consistency.
28+
- [ ] Update onboarding/contribution docs with Copilot/AI context instructions.
29+
- [ ] (Optional) Implement ManifestSync CLI for auto-updating manifest from codebase.
30+
- [ ] Enforce the rule: every new Story must have both English and Chinese versions.
31+
32+
**Notes**
33+
- This ensures all Copilot/AI agent users have consistent, up-to-date project context, maximizing AI-assisted development efficiency.
34+
- The solution is vendor-agnostic and can be extended to other AI agents.
35+
- The manifest and Nuke integration provide a single source of truth and a unified developer experience.
36+
- Bilingual Story documentation is now a required part of the AI context standard.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!-- 优先级:P0 -->
2+
<!-- 状态:未开始 -->
3+
# S-0008-AI 上下文清单与 Nuke StartAI 一键注入
4+
5+
**用户故事**
6+
作为一名使用 GitHub Copilot(或任何 AI agent)的开发者,我希望有一个统一的项目上下文清单和 Nuke 命令来一键注入 AI 上下文,这样 Copilot 能立即理解项目架构、规范和目标,无需人工反复说明,所有团队成员的 AI 协作体验也能保持一致。
7+
8+
**验收标准**
9+
- 项目根目录存在 `ai-manifest.yaml`(或 `ai-manifest.json`),描述项目概览、架构、目录/命名规范、路线图和术语表。
10+
- Nuke 提供 `StartAI` 目标,运行 `nuke StartAI` 可输出适合 Copilot/AI agent ingest 的最新上下文。
11+
- 命令支持参数(如 `--role Frontend`)以按角色过滤上下文。
12+
- pre-commit 和 CI 检查保证 manifest 变更与结构/规范同步。
13+
- Onboarding/贡献指南明确要求新成员用 `nuke StartAI` 注入 AI 上下文。
14+
- 团队成员可在 Copilot Chat 用 `/sync``/roadmap``/why <file>` 等指令快速获取上下文(引用 manifest 段落)。
15+
- 每次新增 Story 必须同时提供中英文双版本文档,并作为 AI 上下文规范的一部分。
16+
17+
**技术任务**
18+
- [ ] 在根目录起草并维护 `ai-manifest.yaml`,内容包括:
19+
- 项目概览(愿景、特性、技术栈)
20+
- 架构(模块、DI、插件系统、数据流)
21+
- 目录与命名规范
22+
- 路线图/里程碑
23+
- 术语表与常见问题
24+
- [ ] 在 Nuke 构建脚本中添加 `StartAI` 目标。
25+
- [ ] 实现聚合 manifest、README、进度报告等上下文的输出逻辑。
26+
- [ ] 支持按角色过滤上下文(如 `nuke StartAI --role Backend`)。
27+
- [ ] 添加 pre-commit 和 CI 检查,保证 manifest 一致性。
28+
- [ ] 更新 Onboarding/贡献文档,说明 Copilot/AI 上下文注入方法。
29+
- [ ] (可选)实现 ManifestSync CLI,自动从代码生成/更新 manifest。
30+
- [ ] 明确 Story 文档编写规范:每次新增 Story 必须同时提供中英文双版本。
31+
32+
**说明**
33+
- 该方案确保所有 Copilot/AI agent 用户都能获得一致、最新的项目上下文,最大化 AI 协作开发效率。
34+
- 该规范适用于所有 Story 文档,要求每次新增 Story 必须有中英文双版本。

0 commit comments

Comments
 (0)