spec-kitty-research

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Path reference rule: When you mention directories or files, provide either the absolute path or a path relative to the project root (for example,

kitty-specs/<feature>/tasks/

). Never refer to a folder by name alone.

Path: .kittify/templates/commands/research.md

路径引用规则： 当你提及目录或文件时，请提供绝对路径或相对于项目根目录的路径（例如

kitty-specs/<feature>/tasks/

）。切勿仅通过名称引用文件夹。

路径：.kittify/templates/commands/research.md

Location Pre-flight Check

位置预检

BEFORE PROCEEDING: Verify you are working in the primary repository checkout.

bash

pwd
git branch --show-current

Expected output:

```
pwd
```
: Should end with
```
primary repository checkout
```
(or similar primary repository checkout)
Branch: Should show your feature branch name like
```
001-feature-name
```
(NOT
```
main
```
)

If you see the main branch or main repository path:

⛔ STOP - You are in the wrong location!

This command creates research artifacts in your feature directory. You must be in the primary repository checkout.

Correct the issue:

Navigate to your primary repository checkout:
```
cd primary repository checkout
```
Verify you're on the correct feature branch:
```
git branch --show-current
```
Then run this research command again

开始操作前： 确认你正工作在主代码库检出目录中。

bash

pwd
git branch --show-current

预期输出：

```
pwd
```
：路径应以「主代码库检出目录」结尾（或类似的主代码库检出路径）
分支：应显示你的功能分支名称，例如
```
001-feature-name
```
（不是
```
main
```
分支）

如果看到main分支或主代码库路径错误：

⛔ 停止操作 - 你处于错误的位置！

此命令会在你的功能目录中创建研究工件。你必须处于主代码库检出目录中。

解决方法：

导航到你的主代码库检出目录：
```
cd primary repository checkout
```
确认你在正确的功能分支上：
```
git branch --show-current
```
重新运行此研究命令

What This Command Creates

该命令会创建什么

When you run

spec-kitty research

, the following files are generated in your feature directory:

Generated files:

research.md – Decisions, rationale, and supporting evidence
data-model.md – Entities, attributes, and relationships
research/evidence-log.csv – Sources and findings audit trail
research/source-register.csv – Reference tracking for all sources

Location: All files go in

kitty-specs/001-feature-name/

当你运行

spec-kitty research

时，会在你的功能目录中生成以下文件：

生成的文件:

research.md – 决策记录、理由说明及支持证据
data-model.md – 实体、属性及关系定义
research/evidence-log.csv – 来源与发现的审计追踪日志
research/source-register.csv – 所有参考来源的追踪记录

存放位置：所有文件均会放入

kitty-specs/001-feature-name/

Workflow Context

工作流上下文

Before this:

/spec-kitty.plan

calls this as "Phase 0" research phase

This command:

Scaffolds research artifacts
Creates templates for capturing decisions and evidence
Establishes audit trail for traceability

After this:

Fill in research.md, data-model.md, and CSV logs with actual findings
Continue with
```
/spec-kitty.plan
```
which uses your research to drive technical design

在此之前：

/spec-kitty.plan

将此步骤称为「Phase 0」研究阶段

本命令:

搭建研究工件的基础框架
创建用于记录决策和证据的模板
建立可追溯的审计追踪机制

在此之后:

向research.md、data-model.md及CSV日志中填充实际研究结果
继续执行
```
/spec-kitty.plan
```
，该流程会基于你的研究成果推进技术设计

Goal

目标

Create

research.md

data-model.md

, and supporting CSV stubs based on the active mission so implementation planning can reference concrete decisions and evidence.

基于当前任务创建

research.md

、

data-model.md

及配套的CSV stub文件，以便实现规划阶段可以参考具体的决策和证据。

What to do

操作步骤

You should already be in the correct primary repository checkout (verified above with pre-flight check).
Run
```
spec-kitty research
```
to generate the mission-specific research artifacts. (Add
```
--force
```
only when it is acceptable to overwrite existing drafts.)
Open the generated files and fill in the required content:
- ```
research.md
```
  – capture decisions, rationale, and supporting evidence.
- ```
data-model.md
```
  – document entities, attributes, and relationships discovered during research.
- ```
research/evidence-log.csv
```
  &
```
research/source-register.csv
```
  – log all sources and findings so downstream reviewers can audit the trail.
If your research generates additional templates (spreadsheets, notebooks, etc.), store them under
```
research/
```
and reference them inside
```
research.md
```
.
Summarize open questions or risks at the bottom of
```
research.md
```
. These should feed directly into
```
/spec-kitty.tasks
```
and future implementation prompts.

你应已处于正确的主代码库检出目录中（已通过上述预检步骤验证）。
运行
```
spec-kitty research
```
命令生成任务专属的研究工件。（仅当可以覆盖现有草稿时，才添加
```
--force
```
参数。）
打开生成的文件并填写所需内容：
- ```
research.md
```
  – 记录决策、理由及支持证据。
- ```
data-model.md
```
  – 记录研究过程中发现的实体、属性及关系。
- ```
research/evidence-log.csv
```
  &
```
research/source-register.csv
```
  – 记录所有来源与发现，以便下游评审人员可以追踪审计路径。
如果你的研究生成了额外的模板（如电子表格、笔记本等），请将其存储在
```
research/
```
目录下，并在
```
research.md
```
中引用它们。
在
```
research.md
```
底部总结未解决的问题或风险。这些内容应直接纳入
```
/spec-kitty.tasks
```
及后续的实现提示中。

Success Criteria

成功标准

```
kitty-specs/<feature>/research.md
```
explains every major decision with references to evidence.
```
kitty-specs/<feature>/data-model.md
```
lists the entities and relationships needed for implementation.
CSV logs exist (even if partially filled) so evidence gathering is traceable.
Outstanding questions from the research phase are tracked and ready for follow-up during planning or execution.

```
kitty-specs/<feature>/research.md
```
需结合证据说明每一项主要决策。
```
kitty-specs/<feature>/data-model.md
```
需列出实现所需的实体及关系。
CSV日志已存在（即使仅部分填充），确保证据收集过程可追溯。
研究阶段发现的未解决问题已被记录，并可在规划或执行阶段跟进处理。