- 将 README.md 重构为开发文档,包含开发环境、工作流、代码规范 - 新建 skill/SKILL.md 作为用户文档,包含快速开始和命令选项 - 更新 openspec/config.yaml 添加项目概述和 skill 目录声明
28 lines
1.3 KiB
YAML
28 lines
1.3 KiB
YAML
schema: spec-driven
|
||
|
||
context: |
|
||
# 项目概述
|
||
- 目标:统一文档解析工具,将DOCX/XLSX/PPTX/PDF/HTML/URL 转换为 Markdown,面向AI skill使用
|
||
|
||
# 项目规范
|
||
- 语言: 仅中文(交流/注释/文档/代码)
|
||
- Python: 始终用uv运行(脚本/临时命令uv run python -c); 禁用主机python/禁主机安装包
|
||
- 依赖: pyproject.toml声明,使用uv安装
|
||
- 主机环境: 禁止污染配置,需操作须请求用户
|
||
- 开发文档: README.md,每次迭代按需更新开发文档; 禁emoji/特殊字符
|
||
- skill文档: skill/SKILL.md,每次迭代按需更新skill文档
|
||
- 测试: 所有需求必须设计全面测试
|
||
- 任务: 禁止创建git变更任务(push/commit等); git读取允许(status/log/diff等)
|
||
- 代码: 模块文件150-300行; 错误需自定义异常+清晰信息+位置上下文
|
||
- 项目阶段: 未上线,无用户,破坏性变更无需迁移说明
|
||
- Git提交: 仅中文; 格式为"类型: 简短描述",类型可选: feat(新功能)/fix(修复)/refactor(重构)/docs(文档)/style(格式)/test(测试)/chore(构建/工具); 多行描述空行后加详细说明
|
||
|
||
# 项目目录结构
|
||
- scripts/: 核心代码目录
|
||
- skill/: skill文档目录
|
||
- tests/: 测试目录
|
||
- openspec/: 规范文档目录
|
||
- temp/: 开发临时文件目录
|
||
- pyproject.toml: 项目配置
|
||
- README.md: 项目开发文档
|