Back to Details

gsdl-setup-project

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Setup Project

项目搭建

Creates a standardized project structure for new ideas, prototypes, or tools in the research workspace. Each project gets its own isolated folder with task tracking and documentation structure.
为研究工作区中的新想法、原型或工具创建标准化的项目结构。每个项目都有独立的隔离文件夹，配套任务跟踪和文档结构。

Goal

目标

Ensure every new idea, prototype, or tool is organized into its own dedicated folder structure. This keeps the workspace clean and ensures each project has proper context, requirements, and task tracking from the start.
确保每个新想法、原型或工具都被整理到专属的文件夹结构中。这可以保持工作区整洁，确保每个项目从一开始就有完整的上下文、需求说明和任务跟踪机制。

Project Structure Requirements

项目结构要求

Every new project must include:
  1. Isolated Project Folder: Dedicated directory under 
    .planning/
    (e.g., 
    .planning/project-name/
    )
  2. Seed File: Initial idea capture at 
    .planning/project-name/seed.md
  3. Containment: All planning files (seed, PRDs, task lists, decisions) stay within 
    .planning/[project-name]/
每个新项目必须包含：
  1. 隔离项目文件夹：位于 
    .planning/
    下的专属目录（例如 
    .planning/project-name/
    ）
  2. 种子文件：存放在 
    .planning/project-name/seed.md
    的初始想法记录文件
  3. 内容收敛：所有规划文件（种子文件、PRD、任务清单、决策记录）都必须放在 
    .planning/[project-name]/
    目录下

Setup Workflow

搭建工作流

Step 1: Identify Project Name

步骤1：确定项目名称

Choose a short, descriptive name:
  • Use kebab-case (lowercase with hyphens)
  • Keep it concise and meaningful
  • Examples: 
    user-authentication
    , 
    task-manager
    , 
    api-client
选择简短、描述性的名称：
  • 使用 kebab-case 命名规范（全小写，单词间用短横线连接）
  • 保持简洁有意义
  • 示例：
    user-authentication
    、
    task-manager
    、
    api-client

Step 2: Create Directory Structure

步骤2：创建目录结构

Create the project folders:
bash
mkdir -p .planning/[project-name]
创建项目文件夹：
bash
mkdir -p .planning/[project-name]

Step 3: Create Seed File

步骤3：创建种子文件

Create 
.planning/[project-name]/seed.md
to capture the initial idea:
Seed File Purpose:
  • Informal and flexible format
  • Captures raw thinking before formalization
  • Serves as input for PRD creation
What to Include:
  • The initial problem or opportunity
  • Rough feature ideas or concepts
  • Inspiration or reference links
  • Questions or uncertainties
  • Any initial thoughts that will help inform the PRD
创建 
.planning/[project-name]/seed.md
用于记录初始想法：
种子文件用途：
  • 非正式的灵活格式
  • 用于在正式规范化之前记录原始思路
  • 作为PRD创作的输入材料
需要包含的内容：
  • 初始的问题或者机会点
  • 粗略的功能想法或者概念
  • 灵感来源或者参考链接
  • 疑问或者不确定的点
  • 所有能够为PRD提供参考的初始想法

Step 4: Confirm Setup

步骤4：确认搭建完成

Inform the user:
  • Show the created structure
  • Confirm the seed file location
  • Explain next steps (creating PRD, etc.)
告知用户：
  • 展示已创建的结构
  • 确认种子文件的位置
  • 说明后续步骤（创建PRD等）

Seed File Format

种子文件格式

The seed file is intentionally informal and flexible. Here's a template:
markdown
undefined
种子文件刻意设计为非正式、灵活的形式，模板如下：
markdown
undefined

[Project Name]

[项目名称]

Initial Idea

初始想法

[Brief description of what you want to build]
[你想要搭建的项目的简要说明]

Problem/Opportunity

问题/机会点

[What problem does this solve? Why build this?]
[这个项目解决了什么问题？为什么要做这个项目？]

Key Features (Initial Thoughts)

核心功能（初步想法）

  • Feature idea 1
  • Feature idea 2
  • Feature idea 3
  • 功能想法1
  • 功能想法2
  • 功能想法3

Inspiration/References

灵感/参考资料

  • [Links to similar tools, articles, etc.]
  • [类似工具、文章等链接]

Questions/Uncertainties

疑问/不确定点

  • Question 1?
  • Question 2?
  • 疑问1？
  • 疑问2？

Next Steps

后续步骤

  • Create PRD
  • Generate task list
undefined
  • 创建PRD
  • 生成任务清单
undefined

Complete Directory Structure Example

完整目录结构示例

After setup, the project should look like:
workspace-root/
├── .planning/
│   └── project-name/
│       └── seed.md           # Initial idea capture
└── (source code files live at workspace root, not in .planning/)
As the project evolves:
workspace-root/
├── .planning/
│   └── project-name/
│       ├── seed.md
│       ├── prd-feature-name.md
│       └── tasks-prd-feature-name.md
├── src/
│   └── (implementation files)
├── tests/
│   └── (test files)
└── README.md
搭建完成后，项目结构应该如下：
workspace-root/
├── .planning/
│   └── project-name/
│       └── seed.md           # 初始想法记录
└── (源代码文件存放在工作区根目录，不在 .planning/ 下)
随着项目演进：
workspace-root/
├── .planning/
│   └── project-name/
│       ├── seed.md
│       ├── prd-feature-name.md
│       └── tasks-prd-feature-name.md
├── src/
│   └── (实现代码文件)
├── tests/
│   └── (测试文件)
└── README.md

Integration with Other Skills

与其他技能的集成

After setting up a project, guide the user through the workflow:
  1. gsdl-setup-project (this skill) → Creates structure and seed.md
  2. gsdl-create-prd → Uses seed.md to generate PRD
  3. gsdl-create-plan → Breaks down PRD into tasks
  4. gsdl-execute-plan → Guides implementation
完成项目搭建后，引导用户按以下工作流推进：
  1. gsdl-setup-project（本技能）→ 创建结构和seed.md
  2. gsdl-create-prd → 使用seed.md生成PRD
  3. gsdl-create-plan → 将PRD拆解为任务
  4. gsdl-execute-plan → 引导项目实现

Important Rules

重要规则

  1. Containment: All planning files (seed, PRDs, task lists, decisions) must stay within 
    .planning/[project-name]/
  2. Implementation code lives at workspace root: Source files, tests, and README go at the repo root — not inside 
    .planning/
  3. Consistent naming: Use kebab-case for project names
  4. Seed first: Always create seed.md before PRD
  1. 内容收敛：所有规划文件（种子文件、PRD、任务清单、决策记录）必须存放在 
    .planning/[project-name]/
    目录下
  2. 实现代码存放在工作区根目录：源文件、测试文件和README放在仓库根目录，不要放在 
    .planning/
    内部
  3. 统一命名规范：项目名称使用kebab-case
  4. 种子文件优先：永远在创建PRD之前先创建seed.md

Example Interaction

交互示例

User: "I want to start a new project for user authentication"

AI: "I'll set up a new project structure for user authentication.

Created:
- .planning/user-authentication/
- .planning/user-authentication/seed.md

The seed file is ready for you to document your initial ideas. Once you've added your thoughts to the seed file, I can help you create a PRD using the gsdl-create-prd skill.

Would you like me to help you populate the seed file now, or would you prefer to write it yourself first?"
用户："我想要启动一个用户认证相关的新项目"

AI："我将为用户认证项目搭建新的项目结构。

已创建：
- .planning/user-authentication/
- .planning/user-authentication/seed.md

种子文件已经准备好，你可以在里面记录你的初始想法。等你把想法补充到种子文件后，我可以使用gsdl-create-prd技能帮你创建PRD。

你希望我现在帮你填充种子文件，还是你先自己编写？"

Edge Cases

边界情况处理

Project Already Exists

项目已存在

If a project folder already exists:
  1. Check if it has the required structure (seed.md)
  2. Add missing components without overwriting existing files
  3. Inform the user what was added
如果项目文件夹已经存在：
  1. 检查是否包含要求的结构（seed.md）
  2. 补充缺失的组件，不要覆盖已有文件
  3. 告知用户新增了哪些内容

Similar Project Names

项目名称相似

If a similar project name exists:
  1. Suggest an alternative name or numbered suffix
  2. Ask the user to confirm or provide a different name
  3. Examples: 
    auth-system-2
    , 
    auth-system-v2
    , 
    oauth-integration
如果已经存在相似的项目名称：
  1. 建议替代名称或者带数字的后缀
  2. 请用户确认或者提供其他名称
  3. 示例：
    auth-system-2
    、
    auth-system-v2
    、
    oauth-integration

Multiple Projects

多个项目

If the user wants to set up multiple projects:
  1. Set up each project separately
  2. Confirm each project's structure before moving to the next
  3. Summarize all created projects at the end
如果用户想要搭建多个项目：
  1. 分别搭建每个项目
  2. 每个项目的结构确认后再推进下一个
  3. 最后总结所有已创建的项目

File Path Standards

文件路径标准

Always use full paths relative to workspace root:
  • Correct: 
    .planning/[project-name]/prd-feature.md
  • Correct: 
    src/components/Auth.tsx
    (implementation code lives at workspace root, not in 
    .planning/
    )
  • Incorrect: 
    [project-name]/prd-feature.md
    (missing 
    .planning/
    prefix)
  • Incorrect: 
    ./src/Auth.tsx
    (relative path)
始终使用相对于工作区根目录的完整路径：
  • 正确：
    .planning/[project-name]/prd-feature.md
  • 正确：
    src/components/Auth.tsx
    （实现代码存放在工作区根目录，不在 
    .planning/
    下）
  • 错误：
    [project-name]/prd-feature.md
    （缺少 
    .planning/
    前缀）
  • 错误：
    ./src/Auth.tsx
    （相对路径）

Next Steps After Setup

搭建后的后续步骤

After creating the project structure, typically:
  1. Populate seed.md: Either help the user fill it out or let them do it
  2. Create PRD: Use the gsdl-create-prd skill to formalize requirements
  3. Generate tasks: Use gsdl-create-plan to break down the PRD
  4. Start implementation: Use gsdl-execute-plan to guide development
创建完项目结构后，通常按以下步骤推进：
  1. 填充seed.md：要么帮助用户填写，要么让用户自行完成
  2. 创建PRD：使用gsdl-create-prd技能将需求规范化
  3. 生成任务：使用gsdl-create-plan将PRD拆解为任务
  4. 启动实现：使用gsdl-execute-plan引导开发流程

Quick Setup Command

快速搭建命令

For quick reference, the complete setup:
bash
mkdir -p .planning/[project-name]
touch .planning/[project-name]/seed.md
Then populate the seed file with the initial idea.
供快速参考，完整搭建命令：
bash
mkdir -p .planning/[project-name]
touch .planning/[project-name]/seed.md
之后在种子文件中填充初始想法即可。