datai/docs/archive/skill/0001-bootstrap-workflow.md

name	description
0001-bootstrap-workflow	初始化项目协作基线，创建项目蓝图和协作协议文档

技能：项目协作基线初始化 (Bootstrap Workflow)

元数据 (Metadata)

• name: bootstrap-workflow
• description: 初始化项目协作基线，创建项目蓝图和协作协议文档
• version: 1.0.0
• author: SSOT Architect
• lastUpdated: 2026-01-15

触发与定位 (Triggers & Scope)

触发条件 (Triggers)

当以下情况发生时，AI 应当"觉醒"本技能：

1. 新项目初始化: 用户要求初始化一个新的 Datai 项目
2. 缺少协作文档: 检测到项目根目录缺少 README.md、CONTRIBUTING.md 或 CHANGELOG.md
3. 工作流启动: 用户输入 "Start Workflow: [任务名称]" 指令
4. 文档结构检查: 在执行任何开发任务前，发现项目文档结构不完整

定位范围 (Scope)

• 适用模块: 所有 Datai 项目模块
• 影响文件: 项目根目录的协作文档
• 相关技能: skill-establish-ssot-hub, skill-setup-information-architecture

核心指令集 (Instructions)

架构约束 (Architecture Constraints)

1. 必须创建的文件:

   • README.md - 项目蓝图，必须包含指向 docs/index.md 的显著链接
   • CONTRIBUTING.md - AI 与人类协作协议
   • CHANGELOG.md - 项目变更日志

2. README.md 必须包含:

   • 项目简介
   • 技术栈
   • 快速开始指南
   • 显著链接: 指向 docs/index.md 的链接
   • 贡献指南链接

3. CONTRIBUTING.md 必须包含:

   • 项目协作流程
   • 提交规范
   • 代码审查流程
   • 文档更新要求

4. CHANGELOG.md 必须包含:

   • 版本历史
   • 变更类型说明（feat, fix, docs, refactor, etc.）
   • 变更日期

业务逻辑 SOP (Business Logic SOP)

步骤 1: 检查现有文档

# 检查项目根目录是否存在必需文件
if [ ! -f "README.md" ]; then
    echo "警告: README.md 不存在"
fi

if [ ! -f "CONTRIBUTING.md" ]; then
    echo "警告: CONTRIBUTING.md 不存在"
fi

if [ ! -f "CHANGELOG.md" ]; then
    echo "警告: CHANGELOG.md 不存在"
fi

步骤 2: 创建 README.md

# [项目名称]

> 项目唯一真源入口：[docs/index.md](docs/index.md)

## 项目简介
[项目描述]

## 技术栈
- Java 17/21
- Spring Boot 3.x
- MyBatis Plus
- Salesforce API

## 快速开始
[快速开始步骤]

## 文档导航
- [完整文档](docs/index.md)
- [贡献指南](CONTRIBUTING.md)
- [变更日志](CHANGELOG.md)

## 许可证
[许可证信息]

步骤 3: 创建 CONTRIBUTING.md

# 贡献指南

## 协作流程
本项目遵循严格的 SSOT（Single Source of Truth）架构，所有开发必须遵循文档驱动的流程。

## 提交规范
### Commit Message 格式

():

```

类型说明

• feat: 新功能
• fix: 修复 Bug
• docs: 文档更新
• refactor: 代码重构
• test: 测试相关
• chore: 构建/工具相关

提交要求

• 每次提交必须包含代码和对应的文档变更
• 提交消息必须引用相关需求或决策文档

代码审查

• 所有代码必须经过审查
• 审查重点：文档完整性、代码质量、测试覆盖

文档更新要求

• 任何代码变更必须先更新文档
• 禁止在没有文档依据的情况下编写代码

#### 步骤 4: 创建 CHANGELOG.md
```markdown
# 变更日志

所有项目重要变更都将记录在此文件中。

格式基于 [Keep a Changelog](https://keepachangelog.com/)

## [Unreleased]

### Added
- 新增功能列表

### Changed
- 变更列表

### Deprecated
- 废弃的功能

### Removed
- 移除的功能

### Fixed
- 修复的问题

## [1.0.0] - 2026-01-15

### Added
- 初始版本发布

步骤 5: 执行 Bootstrap 提交

git add README.md CONTRIBUTING.md CHANGELOG.md
git commit -m "chore: 初始化项目协作基线文档

- Creates: README.md, CONTRIBUTING.md, CHANGELOG.md
- Establishes: Project collaboration baseline
- Context: Bootstrap workflow initialization"

工具调用 (Tool Usage)

1. 文件检查工具:

   • 使用 LS 工具检查项目根目录
   • 使用 Read 工具读取现有文档内容

2. 文件创建工具:

   • 使用 Write 工具创建新文档
   • 确保文件路径正确（项目根目录）

3. Git 操作工具:

   • 使用 RunCommand 执行 git add 和 git commit
   • 确保提交消息符合规范

错误陷阱与验证 (Anti-Patterns & Checklist)

常见错误 (Anti-Patterns)

1. 错误: 创建 README.md 但缺少指向 docs/index.md 的链接

   • 后果: 用户无法找到项目文档入口
   • 修正: 必须在 README.md 中包含显著的文档链接

2. 错误: CONTRIBUTING.md 内容过于简单

   • 后果: 开发者不清楚协作流程
   • 修正: 必须包含详细的协作流程和提交规范

3. 错误: CHANGELOG.md 格式不规范

   • 后果: 难以追踪变更历史
   • 修正: 使用 Keep a Changelog 格式

4. 错误: Bootstrap 提交不包含所有三个文件

   • 后果: 协作基线不完整
   • 修正: 一次性提交所有三个文件

验收清单 (Acceptance Checklist)

• README.md 已创建并包含指向 docs/index.md 的链接
• CONTRIBUTING.md 已创建并包含协作流程
• CHANGELOG.md 已创建并使用规范格式
• 所有三个文件已提交到 Git
• 提交消息符合规范格式
• 项目根目录结构清晰

Correct vs Incorrect 对比

Correct 示例

# Datai Salesforce 集成

> 项目唯一真源入口：[docs/index.md](docs/index.md)

## 项目简介
Datai Salesforce 集成模块提供与 Salesforce 系统的完整集成能力...

## 文档导航
- [完整文档](docs/index.md)
- [贡献指南](CONTRIBUTING.md)
- [变更日志](CHANGELOG.md)

Incorrect 示例

# Datai Salesforce 集成

## 项目简介
Datai Salesforce 集成模块提供与 Salesforce 系统的完整集成能力...

## 快速开始
[快速开始步骤]

问题: 缺少指向 docs/index.md 的显著链接，用户无法找到完整文档。

相关文档 (Related Documents)

• 工作流提示词
• 建立真源中心技能
• 落地区信息架构技能
• 项目根目录规范