Loading...
Loading...
Compare original and translation side by side
| 路径 | 适用情况 | 产出 |
|---|---|---|
| 空仓库路径 | 仓库内无任何 spec 类文档,也没有 | 完整的 |
| 迁移路径 | 仓库内已有零散文档、 | 审计报告 + 迁移映射方案(用户逐一确认)+ 落盘 |
| Path | Applicable Scenario | Output |
|---|---|---|
| Empty Repository Path | No spec-type documents or | Complete |
| Migration Path | The repository already has scattered documents, | Audit report + migration mapping plan (confirmed by user one by one) + finalization |
onboarding 完成后,共享路径与命名约定的权威版本是项目里的——由本技能从技能包里复制过去。下面只列 onboarding 需要创建或检查的骨架文件。codestable/reference/shared-conventions.md
After onboarding is completed, the authoritative version of shared paths and naming conventions isin the project—copied from the skill package by this skill. Only the skeleton files that need to be created or checked during onboarding are listed below.codestable/reference/shared-conventions.md
codestable/
├── requirements/ ← 需求聚合根(空目录,.gitkeep):"为什么要有这个能力"(只记现状)
├── architecture/
│ └── DESIGN.md ← 架构总入口骨架(首次创建时为占位模板):"用什么结构实现"(只记现状)
├── roadmap/ ← 规划层聚合根(空目录,.gitkeep):"接下来打算怎么走",独立于现状档案
├── features/ ← feature 聚合根(空目录,.gitkeep)
├── issues/ ← issue 聚合根(空目录,.gitkeep)
├── compound/ ← 沉淀类统一目录(空目录,.gitkeep):learning / trick / decision / explore 四种文档按 doc_type + 文件名中间的类型段(YYYY-MM-DD-{doc_type}-{slug}.md)区分
├── tools/ ← 跨工作流共享的脚本工具(由 onboarding 从技能包释放)
│ ├── search-yaml.py ← 通用 YAML frontmatter 搜索工具
│ └── validate-yaml.py ← YAML 语法校验工具
└── reference/ ← 跨子技能共享的参考文档(由 onboarding 从技能包释放)
├── shared-conventions.md ← 共享元数据口径、checklist 生命周期、阶段收尾推荐
├── tools.md ← 共享脚本用法参考
└── maintainer-notes.md ← 断点恢复、扩展点、维护规则AGENTS.mdcodestable/AGENTS.mdcodestable/
├── requirements/ ← Root directory for requirement aggregation (empty directory, .gitkeep): "Why this capability is needed" (only records current status)
├── architecture/
│ └── DESIGN.md ← Architecture entry skeleton (placeholder template when first created): "What structure to use for implementation" (only records current status)
├── roadmap/ ← Root directory for planning layer aggregation (empty directory, .gitkeep): "Plans for future development", independent of current status archives
├── features/ ← Root directory for feature aggregation (empty directory, .gitkeep)
├── issues/ ← Root directory for issue aggregation (empty directory, .gitkeep)
├── compound/ ← Unified directory for accumulated content (empty directory, .gitkeep): learning / trick / decision / explore four document types are distinguished by doc_type + the type segment in the middle of the filename (YYYY-MM-DD-{doc_type}-{slug}.md)
├── tools/ ← Cross-workflow shared script tools (released from the skill package during onboarding)
│ ├── search-yaml.py ← General YAML frontmatter search tool
│ └── validate-yaml.py ← YAML syntax validation tool
└── reference/ ← Reference documents shared across sub-skills (released from the skill package during onboarding)
├── shared-conventions.md ← Shared metadata standards, checklist lifecycle, recommended phase closure practices
├── tools.md ← Usage reference for shared scripts
└── maintainer-notes.md ← Breakpoint recovery, extension points, maintenance rulesAGENTS.mdcodestable/AGENTS.mdcodestable/easysdd/easysdd/codestable/easysdd/codestable/检测到旧版目录(CodeStable 前身)。建议直接easysdd/把目录名迁过来,原目录下的文件结构完全一致、frontmatter 字段也完全兼容,rename 后直接可用。要我帮你执行吗?git mv easysdd codestable
git mv easysdd codestablecodestable/tools/reference/codestable/easysdd/.mdnode_modules/.git/DESIGN.mdARCHITECTURE.mdSPEC.mdREADME.mddocs/doc/design/spec/wiki/codestable/AGENTS.mdcodestable/easysdd/easysdd/codestable/easysdd/codestable/Detected the olddirectory (predecessor of CodeStable). It is recommended to directly runeasysdd/to rename the directory. The file structure and frontmatter fields in the original directory are completely compatible, and it can be used directly after renaming. Would you like me to execute this for you?git mv easysdd codestable
git mv easysdd codestablecodestable/tools/reference/codestable/easysdd/.mdnode_modules/.git/DESIGN.mdARCHITECTURE.mdSPEC.mdREADME.mddocs/doc/design/spec/wiki/codestable/AGENTS.mdREADME.mdcodestable/README.mdcodestable/DESIGN.mdAGENTS.mdcodestable/requirements/.gitkeepcodestable/architecture/DESIGN.mdreference.mdcodestable/roadmap/.gitkeepcodestable/features/.gitkeepcodestable/issues/.gitkeepcodestable/compound/.gitkeepcodestable/tools/cp -rfCopy-Item -Recurse -Forcecs-onboard/tools/codestable/reference/cs-onboard/reference/落盘用 shell 命令整目录覆盖,不要一个文件再Read一个文件——这两个目录是机器共享资产,Read+Write 链路容易截断大文件、改缩进、吃空行,还慢还费 token。迁移路径步骤 4 里给了具体命令示例,空仓库路径也照着执行。Write
AGENTS.md还不存在。它是 CodeStable 所有子工作流的"项目硬约束入口"——记录代码规范、已知坑、禁止事项。建议现在创建一个最小版本。你想现在填,还是之后自己创建?AGENTS.md
reference.mdCodeStable 骨架已就绪。现在可以:
- 开始一个新功能:触发
技能cs-feat- 报告一个问题:触发
技能cs-issue- 沉淀知识:触发
技能cs-learn
DESIGN.mdAGENTS.mdcodestable/requirements/.gitkeepcodestable/architecture/DESIGN.mdreference.mdcodestable/roadmap/.gitkeepcodestable/features/.gitkeepcodestable/issues/.gitkeepcodestable/compound/.gitkeepcodestable/tools/cs-onboard/tools/cp -rfCopy-Item -Recurse -Forcecodestable/reference/cs-onboard/reference/Use shell commands to overwrite the entire directory when finalizing, do nota file thenReadit—these two directories are machine-shared assets, and the Read+Write link can easily truncate large files, modify indentation, eat blank lines, and is slow and token-consuming. Specific command examples are given in Step 4 of the migration path, and the empty repository path should follow the same execution.Write
AGENTS.mddoes not exist yet. It is the "project hard constraint entry" for all CodeStable sub-workflows—recording code specifications, known pitfalls, and prohibited items. It is recommended to create a minimal version now. Would you like to fill it in now, or create it later yourself?AGENTS.md
reference.mdCodeStable skeleton is ready. Now you can:
- Start a new feature: Trigger the
skillcs-feat- Report an issue: Trigger the
skillcs-issue- Accumulate knowledge: Trigger the
skillcs-learn
codestable/codestable/| 现有文件 | 推测内容类型 | 建议归入 CodeStable 位置 | 置信度 |
|---|---|---|---|
| 项目架构文档 | | 高 |
| 某功能的设计稿 | | 中 |
| 功能需求文档? | 需用户确认 | 低 |
| ... | ... | ... | ... |
AskUserQuestioncodestable/YYYY-MM-DD-{slug}.gitkeep.mdcodestable/tools/codestable/reference/cs-onboard/tools/cs-onboard/reference/undefined| Existing File | Inferred Content Type | Suggested CodeStable Location | Confidence |
|---|---|---|---|
| Project architecture document | | High |
| Design draft of a feature | | Medium |
| Feature requirement document? | Need user confirmation | Low |
| ... | ... | ... | ... |
AskUserQuestioncodestable/YYYY-MM-DD-{slug}.gitkeep.mdcodestable/tools/codestable/reference/cs-onboard/tools/cs-onboard/reference/undefined
错误做法(不要这样做):
- ❌ 用 Read 工具把技能包里的文件读出来,再用 Write 工具粘到项目里——文件稍大就会截断内容、改动缩进、吃掉空行,而且慢、费 token、容易抄错
- ❌ 一个文件一个文件地 `cp`——多一步就多一个出错点
- ❌ 先比 diff 再决定拷不拷——这两个目录的规则就是"无条件覆盖",比 diff 是白费力
技能包路径一般就是当前 skill 的安装目录(比如 `~/.claude/skills/cs-onboard/` 或插件目录下的对应位置)。不确定就先 `ls` 定位一下,再执行拷贝。拷完跑一次 `ls codestable/tools/ codestable/reference/` 验证文件都在。
**步骤 5:处理不迁移的文件**
用户选择"跳过"的文件:**不移动、不删除、不重命名**,在汇报里标注"保留原位(未纳入 CodeStable 体系)"。绝对不允许未经确认就移动或删除任何已有文件——理由很简单:onboarding 的入口只允许 AI 整理而不允许 AI 替用户做删除决定,删错了恢复成本极高。
**步骤 6:AGENTS.md 提醒**(同空仓库路径步骤 3)
**步骤 7:验收汇报**
列出:
- 迁移的文件清单(from → to)
- 新创建的骨架文件清单
- 未迁移的文件清单(保留原位)
- 下一步建议
---
Incorrect approaches (do not do this):
- ❌ Use a Read tool to read files from the skill package, then use a Write tool to paste them into the project—large files will be truncated, indentation will be changed, blank lines will be eaten, and it is slow, token-consuming, and easy to copy incorrectly
- ❌ `cp` files one by one—each extra step increases the chance of error
- ❌ Compare diffs before deciding whether to copy—the rule for these two directories is "unconditional overwrite", comparing diffs is a waste of effort
The skill package path is generally the installation directory of the current skill (e.g., `~/.claude/skills/cs-onboard/` or the corresponding location in the plugin directory). If unsure, first use `ls` to locate it, then execute the copy. After copying, run `ls codestable/tools/ codestable/reference/` to verify all files are present.
**Step 5: Handle Files Not Migrated**
Files the user chooses to "Skip": **Do not move, delete, or rename them**, mark "Retained in original location (not included in CodeStable system)" in the report. It is absolutely not allowed to move or delete any existing files without confirmation—the reason is simple: the onboarding entry only allows AI to organize, not make deletion decisions on behalf of users; deleting incorrectly has extremely high recovery costs.
**Step 6: Reminder about AGENTS.md** (same as Step 3 of the empty repository path)
**Step 7: Acceptance Report**
List:
- List of migrated files (from → to)
- List of newly created skeleton files
- List of non-migrated files (retained in original location)
- Next-step suggestions
---DESIGN.mdAGENTS.mdreference.mdDESIGN.mdAGENTS.mdreference.mdcodestable/requirements/architecture/roadmap/features/issues/compound/tools/reference/codestable/tools/codestable/reference/codestable/architecture/DESIGN.mdAGENTS.mdcodestable/requirements/architecture/roadmap/features/issues/compound/tools/reference/codestable/tools/codestable/reference/codestable/architecture/DESIGN.mdAGENTS.mdcodestable/codestable/codestable/tools/reference/codestable/tools/codestable/reference/cp -rfCopy-Item -Recurse -Forcenode_modules/.git/codestable/codestable/codestable/tools/reference/codestable/tools/codestable/reference/cp -rfCopy-Item -Recurse -Forcenode_modules/.git/codestable/reference/system-overview.mdcodestable/reference/shared-conventions.mdAGENTS.mdcodestable/architecture/DESIGN.mdcodestable/reference/system-overview.mdcodestable/reference/shared-conventions.mdAGENTS.mdcodestable/architecture/DESIGN.md