Skip to content

架构决策记录 (ADR)

本页记录本项目的重要架构决策及其背景。

ADR-0001: 使用 VitePress 构建文档站点

状态: 已接受(替代原有的 Jekyll 方案)

背景: 本项目需要一个文档站点来展示技能列表、使用指南和贡献说明。

决策: 使用 VitePress 作为静态站点生成器,部署到 GitHub Pages

理由:

  1. Vue.js 生态 - 基于 Vite 构建,开发体验极佳
  2. 快速热更新 - 开发时即时预览更改
  3. 内置本地搜索 - 无需额外配置
  4. Mermaid 图表 - 支持 Mermaid 流程图
  5. llms.txt 支持 - 生成 AI 友好的文档索引

后果:

  • 正面: 文档更新只需编辑 Markdown,自动部署,无服务器成本
  • 负面: 需要 Node.js 构建环境

详见 ADR-0001


ADR-0002: 翻译策略

状态: 已接受

背景: 本项目是 awesome-claude-skills 的中文翻译版本。

决策:

  1. 所有面向用户的文档使用中文
  2. 技术术语保留英文(如 Claude、GitHub、Jekyll)
  3. 代码注释可保持英文
  4. SKILL.md 文件翻译为中文

理由:

  1. 降低中文用户的阅读门槛
  2. 保持技术术语的准确性
  3. 便于与上游仓库同步

后果:

  • 正面: 统一用户体验,符合项目定位
  • 负面: 需要持续同步上游变更

详见 ADR-0002


ADR-0003: 学术论文风格设计

状态: 已接受

背景: 用户要求文档站点呈现"学术论文级"的专业度和学术感。

决策:

  1. 采用学术论文排版风格
  2. 仅提供浅色模式
  3. 使用 Serif 标题 + Sans 正文
  4. 引入学术引用机制

理由:

  1. 符合目标受众(高级开发者、研究者)的阅读习惯
  2. 学术风格增强内容可信度
  3. 浅色模式保持论文经典体验

后果:

  • 正面: 专业度高,学术感强
  • 负面: 部分用户可能偏好深色模式

历史决策

编号标题状态日期
0001使用 VitePress已接受2025-01
0002翻译策略已接受2025-01
0003学术论文风格已接受2026-05

Apache License 2.0