SDK_Docs_Template
  • 项目概览
    • 核心设计
    • 这套模板解决什么问题
      • 能力地图与验证边界
        • 输出体验
  • 快速开始
    • 五分钟路径
      • 首次本地构建
        • 预期产物
        • 首次失败时先做什么
  • 内容创作
    • 推荐目录形态
    • 内容表达
      • 内容约定：让文档可以长期维护
        • 文件命名
        • 每篇技术页面的最小结构
      • 双语编写与语言切换
        • 对应页规则
        • 译文质量门槛
  • 内容组织
    • 选择递归文档树还是严格项目目录
      • 选择 recursive_tree
      • 选择 project_catalog
  • 构建与输出
    • 本地工作流
      • 本地构建工作流
      • PDF 交付：排版与环境同样是构建输入
        • 输出特征
  • 版本与部署
    • 发布链路
      • GitHub Actions 与 GitHub Pages 自动发布
        • 工作流阶段
        • PR 与默认分支的行为差异
        • 发布前检查清单
  • 场景化示例
    • 示例：嵌入式 SDK 开发手册
      • 场景
      • 内容策略
      • 验收
    • 示例：BSP 与驱动项目目录
      • 场景
      • 为什么这比递归扫描更可靠
    • 示例：可归档的 PDF 发布手册
      • 场景
      • 建议的内容压力测试
    • 示例：多版本 GitHub Pages 发布
      • 场景
  • 配置参考
    • 高频配置
    • 常用命令
  • 问题排查
    • 排查顺序
  • 维护者指南
    • 架构职责
    • 贡献要求
SDK_Docs_Template
  • 搜索

© 版权所有 2025, KurisaW。

SDK_Docs_Template • 版本：2.0.0
构建时间：