@captain_z/zsk 1.6.0 → 1.7.0

package/templates/project-init/docs/_module-index.md

@@ -1,15 +0,0 @@
-# Module Index
-
-This file is the entry point for project modules. It is maintained by `zsk prep`, `zsk module init`, and AI-assisted module discovery.
-
-Use it to answer three questions before starting a skill stage:
-
-- which modules exist;
-- where each module's `module.yaml` lives;
-- whether the module is ready for proposal/spec/design/task/coding work.
-
-| Module | Name | Config | Status |
-| --- | --- | --- | --- |
-| `<module-id>` | `<module-name>` | `docs/<module-id>/module.yaml` | pending |
-
-Status values are project-owned. Recommended baseline: `pending`, `active`, `blocked`, `verified`, `archived`.

package/templates/project-init/project-config.md

@@ -1,154 +0,0 @@
----
-meta:
-  project_name: "<project-name>"
-  project_type: "<project-type>"
-  project_role: "<project-role>"
-  created: "<YYYY-MM-DD>"
-  maintainers: []
-
-config:
-  machine_config: ".zsk/config.yaml"
-  system_spec: "docs/SYSTEM-SPEC.md"
-
-paths:
-  raws_root: ".raws"
-  raws_index: ".raws/index.md"
-  raws_manifest: ".raws/manifest.json"
-  requirements_index: ".raws/requirements/index.md"
-  api_contracts_index: ".raws/api-contracts/index.md"
-  design_sources_index: ".raws/design-sources/index.md"
-  design_assets_index: ".raws/design-assets/index.md"
-  testing_index: ".raws/testing/index.md"
-  docs_root: "docs"
-  module_index: "docs/_module-index.md"
-  issues_root: ".issues"
-  issues_index: ".issues/README.md"
-
-source_registry:
-  canonical: ".zsk/config.yaml#sources"
-  local_snapshot_root: ".raws"
-  generated_manifest: ".raws/manifest.json"
-
-modules:
-  root: "docs"
-  index: "docs/_module-index.md"
-  module_config: "docs/{module}/module.yaml"
-  module_docs: "docs/{module}/proposal.md | spec.md | design.md | tasks.md | verification.md"
-  module_issues: ".issues/{module}"
-
-scripts:
-  install: "<install command>"
-  dev: "<dev command>"
-  build: "<build command>"
-  lint: "<lint command>"
-  type_check: "<typecheck command>"
-  test: "<test command>"
-  format: "<format command>"
-
-stack:
-  framework: "<framework>"
-  language: "<language>"
-  language_strict: true
-  build_tool: "<build-tool>"
-  css: "<css-stack>"
-  ui_lib: "<ui-library>"
-  test_framework: "<test-framework>"
-
-quality:
-  documentation_feedback_required: true
-  runtime_evidence_root: ".issues"
-  raw_snapshot_root: ".raws"
-  docs_runtime_artifacts_forbidden: true
-
-examples:
-  module_id: "sample-module"
-  issue_id: "BUG-0001"
----
-
-# Project Config — <project-name>
-
-> **定位**：项目级 AI 配置与机械查表锚点。
-> **维护方式**：与 [docs/SYSTEM-SPEC.md](./docs/SYSTEM-SPEC.md) 和 [.zsk/config.yaml](./.zsk/config.yaml) 同步维护。
-> **适用范围**：`.zsk/`、`.raws/`、`docs/`、`.issues/` 和项目代码。
-> **当前结论**：本文件面向人和 AI；机器校验以 `.zsk/config.yaml` 为准。
-
----
-
-## 1. 配置入口
-
-| 文件 | 定位 | 维护方式 |
-|---|---|---|
-| `.zsk/config.yaml` | 机器可读配置：路径、sources、tools、module root | 由 AI/人工编辑，`zsk config check` 校验 |
-| `project-config.md` | 人读项目配置：技术栈、脚本、路径、约束查表 | 与系统规约同步维护 |
-| `docs/SYSTEM-SPEC.md` | 项目级规则、事实源优先级、质量门禁 | 稳定约束变更时更新 |
-
-## 2. 资源入口
-
-| 资源 | 统一入口 | 机器索引 / 配置 | 说明 |
-|---|---|---|---|
-| Raw facts | `.raws/index.md` | `.raws/manifest.json` | 上游事实与本地快照导航 |
-| Requirements | `.raws/requirements/index.md` | `.zsk/config.yaml#sources` | SRS、PRD、验收说明 |
-| API contracts | `.raws/api-contracts/index.md` | `.zsk/config.yaml#sources` | OpenAPI、后端仓库、接口契约 |
-| Design sources | `.raws/design-sources/index.md` | `.zsk/config.yaml#sources` | Figma、Modao、MCP、设计交付源 |
-| Design assets | `.raws/design-assets/index.md` | `.zsk/config.yaml#sources` | token、图片、图标、截图、静态设计资产 |
-| Testing assets | `.raws/testing/index.md` | `.zsk/config.yaml#sources` + `docs/{module}/module.yaml` | QA、验收、发布测试用例 |
-| Issues / evidence | `.issues/README.md` / `.issues/index.md` / `.issues/{module}/index.md` | `.zsk/config.yaml#paths.issues` | bug、截图、日志、复测证据、模块状态索引、全局统计 |
-
-## 3. `.raws` / `docs` / `.issues` 边界
-
-| 目录 | 存放内容 | 不应存放 |
-|---|---|---|
-| `.raws/` | 上游事实、外部资源快照、原始测试资产 | 本地运行截图、debug log、失败验证证据 |
-| `docs/` | 模块 proposal/spec/design/tasks/verification、系统规约 | 运行时证据、HAR、控制台日志 |
-| `.issues/` | 本地缺陷、验证证据、截图、debug log、复测记录 | 上游 SRS/API/Figma 原文快照 |
-
-## 4. Module 文档如何引用资源
-
-模块文档优先通过相对路径引用资源：
-
-```md
-> 原始需求：`.raws/requirements/{file}`
-> API 契约：`.raws/api-contracts/{service}/contracts/{contract}.md`
-> 设计来源：`.raws/design-sources/{module}/`
-> 设计资产：`.raws/design-assets/{module}/`
-> 测试资产：`.raws/testing/{case-file}`
-> 本地问题：`.issues/{module}/BUG-0001-short-slug/issue.md`
-> 模块索引：`.issues/{module}/index.md`
-> 全局统计：`.issues/index.md`
-```
-
-模块级映射写入 `docs/{module}/module.yaml`，项目级来源写入 `.zsk/config.yaml#sources`。
-
-## 5. Coding 约束查表
-
-| 维度 | 当前项目值 | 说明 |
-|---|---|---|
-| Framework | `<framework>` | 从项目实际依赖填写 |
-| Language | `<language>` | TypeScript / Java / Go / etc. |
-| Build | `<build command>` | 与 package manager 保持一致 |
-| Test | `<test command>` | CI 和本地验收都应可复用 |
-| UI / Runtime verification | `playwright_cli / playwright_mcp / browser_use / computer_use` | Playwright 默认执行与证据；Browser Use 复用登录态；Computer Use 处理视觉/系统级场景 |
-
-## 6. 冲突处理顺序
-
-1. 用户明确指令 / 仓库 `AGENTS.md`
-2. `docs/SYSTEM-SPEC.md`
-3. `project-config.md`
-4. `.zsk/config.yaml`
-5. `.raws/` 中的上游事实源
-6. `docs/{module}/proposal.md|spec.md|design.md|tasks.md`
-7. 通用 skills / 模板
-
-如果两个上游事实源冲突，不要静默选择。应在 `.issues/{module}/` 记录冲突，并在模块 `spec.md` 或 `design.md` 的 Documentation Feedback 中写明处理结果。
-
-## 7. 维护清单
-
-项目硬约束新增或调整时，至少同步检查：
-
-- [ ] `.zsk/config.yaml`
-- [ ] `project-config.md`
-- [ ] `docs/SYSTEM-SPEC.md`
-- [ ] `.raws/index.md` 与相关分类 `index.md`
-- [ ] 受影响模块的 `docs/{module}/module.yaml`
-- [ ] 受影响模块的 `docs/{module}/spec.md` / `design.md`
-- [ ] 必要时新增或更新 `.issues/{module}/BUG-xxxx/issue.md`，并同步 `.issues/{module}/index.md` 与 `.issues/index.md`