Skip to content

radebit/OpenSpec-Docs-zh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenSpec-Docs-zh

OpenSpec 官方文档的中文翻译在线版本。 提供完整的单页可交互文档,并对部分英文专有术语进行了本地化调整,以便中文读者更易理解和上手。

官方仓库 本项目 License: MIT


在线预览

页面预览


项目结构

OpenSpec-Docs-zh/
├── index.html              # 主入口(约 450 行,精简骨架)
├── styles.css              # AI 科技风格样式
├── script.js               # 交互脚本(粒子背景、动态加载、侧边栏等)
├── sections/               # 按章节拆分的内容文件(动态加载)
│   ├── getting-started.html # 安装指南 + 快速开始
│   ├── concepts.html       # 核心概念(规范/变更/产物/Delta/Schema)
│   ├── commands.html       # OPSX Slash 命令参考
│   ├── cli.html            # CLI 终端命令参考
│   ├── advanced.html       # 工作流/定制化/支持工具/多语言/贡献
│   ├── practice-guide.html # 实战指南(深入理解/最佳实践/从零开始/FAQ)
│   └── about.html          # 关于文档 + 更新历史
├── assets/                 # 图片资源
│   ├── home-page.jpg       # 页面预览截图
│   ├── openspec_bg.png
│   ├── openspec_dashboard.png
│   ├── openspec_pixel_dark.svg
│   └── openspec_pixel_light.svg
└── README.md               # 本文件

注意sections/ 目录下的文件通过 fetch 动态加载,需通过 HTTP/HTTPS 服务访问(直接双击打开 HTML 文件会因浏览器跨域限制导致内容无法加载)。


文档内容

涵盖 OpenSpec 官方所有核心文档的中文翻译:

章节 对应官方原文
项目概览 & 设计哲学 README.md
安装指南 docs/installation.md
快速开始 docs/getting-started.md
核心概念(规范/变更/产物/Delta/Schema) docs/concepts.md
OPSX Slash 命令参考 docs/commands.md
CLI 终端命令参考 docs/cli.md
工作流模式 docs/workflows.md
自定义配置 docs/customization.md
支持的 AI 工具(24款) docs/supported-tools.md
多语言支持 docs/multi-language.md
实战指南 社区补充内容
关于文档 & 更新历史 社区维护

与官方文档的关系

  • 本项目基于官方英文文档翻译整理,为独立社区项目,非官方出品
  • 当前同步至官方版本:v1.2.0(包含 profile 工作流、工具引用、status 输出等更新)
  • 部分技术术语进行了本地化处理,例如:
    • Source of Truth → 权威基准
    • Brownfield Development → 存量项目开发
    • Artifact → 产物
  • 文档内容会随官方版本迭代定期更新同步

官方资源:


本地运行

无需任何构建工具,纯静态文件,启动服务即可:

# 方式一:Python 3(推荐,无需安装额外依赖)
git clone https://github.com/radebit/OpenSpec-Docs-zh.git
cd OpenSpec-Docs-zh
python3 -m http.server 8080
# 浏览器访问 http://localhost:8080
# 方式二:Node.js
npx serve .
# 方式三:直接打开(部分浏览器支持)
open index.html

部署到 GitHub Pages

  1. Fork 本仓库或 push 到你的 GitHub
  2. 进入仓库 Settings → Pages
  3. Source 选择 main 分支,目录选择 / (root)
  4. 保存后访问 https://<your-username>.github.io/OpenSpec-Docs-zh

参与贡献

欢迎任何形式的贡献,一起让中文文档更完善:

  • 文档勘误:发现翻译错误或表述不准确,欢迎提 Issue
  • 内容补充:有实战经验、使用技巧或示例想分享,欢迎提 PR
  • 术语建议:对某个术语的本地化译法有更好建议,欢迎在 Issue 中讨论

免责声明

本项目为独立社区翻译项目,与 Fission AI 官方团队无任何关联。OpenSpec 的所有权利归属于 Fission AI 及其贡献者,遵循 MIT 协议


License

本翻译文档同样遵循 MIT License

About

OpenSpec 中文社区文档

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages