企业官网建设流程全解析

新课程上库与上线验收标准

【免费下载链接】cann-learning-hubCANN 学习中心仓，支持在线互动运行、边学边练，提供教程、示例与优化方案，一站式助力昇腾开发者快速上手。项目地址: https://gitcode.com/cann/cann-learning-hub

适用范围：所有新增或重构后准备合入cann-learning-hub的课程。

用途：PR 作者自检、Reviewer 验收、课程上库准入判断。

1. 新教程的上线流程

新教程按照课程大纲设计、课程大纲评审、课程内容开发、PR 评审、test 分支内测、问题闭环、master 分支发布的流程推进上线。

2. 课程大纲与能力分层设计规范

课程大纲设计时，应围绕学习者能力成长路径进行整体规划，而不是简单按照知识点堆叠章节。课程组需要明确课程面向的目标学习者、学习起点、最终能力目标，并按照由浅入深的方式设计章节顺序、实践任务和阶段性学习成果。

课程大纲应体现明确的能力分层递进关系，例如初级、中级、高级。每个能力层级需要说明覆盖的章节范围、学习者完成该阶段后应掌握的核心能力、能够独立完成的典型任务，以及对应的考核方式。能力分层设计应为后续不同层级的能力认证考试提供依据，确保课程内容、实践任务和认证考核目标保持一致。

以 Ascend C 算子开发系列课程为例，课程可以按照基础开发能力、工程化开发能力、融合算子与性能优化能力逐级递进设计：

注：章节编号不一定严格代表难度顺序，阶段划分以能力目标为准。

3. 目录结构验收标准

3.1 课程整体结构

每个课程必须按照“课程名称 - 章节名称 - 小节名称”的层级组织，并保持目录结构清晰、可定位、可维护，如：

tutorials/ └── course_name/ ├── README.md ├── 01_chapter_name/ │ ├── 01.01_chapter_intro.ipynb │ ├── 01.02_section_name.ipynb │ ├── 01.03_chapter_test.ipynb │ ├── answer/ │ ├── images/ │ └── src/ └── 02_chapter_name/ ├── 02.01_chapter_intro.ipynb ├── 02.02_section_name.ipynb ├── 02.03_chapter_test.ipynb ├── answer/ ├── images/ └── src/

• 每个课程目录必须包含主README.md，课程目录、章节目录、文件名都使用英文、数字、下划线和必要的点号。
• 章节目录命名必须符合0n_abc格式，例如01_introduction、02_model_training。
• 小节 notebook 命名必须符合0n.0m_abc.ipynb格式，例如01.01_chapter_intro.ipynb。
• 每个章节目录包含多个教程 ipynb，以及answer、images、src三个目录。

3.2 主 README.md 要求

• 包含教程整体简介、适用对象、整体学习目标。
• 必须说明支持或已验证的硬件型号。

3.3 单个章节的结构要求

• 每个章节第一小节必须为章节概述，例如01.01_chapter_intro.ipynb。
  • 章节概述必须包含学习前置要求：学习本章节教程时，开发者需要已经具备的能力、已经学习的前置学习教程/章节，环境要求。
  • 章节概述必须包含章节目标：学完之后开发者能做到什么。
  • 章节概述必须包含章节内容：每一小节的简介和跳转链接。
• 每个章节最后一小节必须为章节实践，例如01.03_chapter_test.ipynb。
  • 章节实践必须包含至少一道综合编程实践题，用于检验本章学习掌握情况。
• 每个章节按照课程实际内容拆分为多个中间小节.ipynb，中间小节.ipynb必须包含小节概述、教程具体内容、课后练习或课后实践。
  • 纯知识点讲解类型的小节——提供课后练习题（选择/填空）。
  • 包含代码实操步骤的小节——提供课后代码实践题（代码编程）。
  • 所有练习、实践、章节实践必须提供答案或参考实现。

3.4 answer、images、src 目录

• images目录用于存放该章节多个小节中的配图。
• answer目录用于存放课后练习、课后实践、章节实践的答案。
• src目录用于存放不便完整写入 notebook 的工程源码。
• answer、images、src目录下可按0n.0m_abc格式新建子目录，以对应具体小节。

4. Notebook 内容验收标准

• 必须包含小节概述、教程具体内容、课后练习或课后实践三个部分。

• 教程具体内容要求：

  • 教程内容行文通顺，逻辑由浅入深。
  • 第一次出现的新概念、新工具、新命令、新参数必须解释清楚，未在章节前置要求或前面章节提及的内容，不得直接默认学习者已经掌握。
  • 适当添加图片辅助讲解。架构、流程、数据流、模型结构、运行结果等复杂内容应优先使用图片或图示说明。
  • 教程正文使用完整可运行的示例代码服务于概念讲解和步骤演示。工程目录创建、依赖安装、代码开发、脚本运行等操作在 notebook 的 code cell 中执行。学习者应不需要手动打开其他文件夹才能理解或完成教程。
  • notebook 中必须说明每个关键源码文件的作用。
  • 当因为源码较多，无法全部在 notebook 展示，必须存入src目录时，notebook 中必须通过 code cell 提供cat、tree、ls等命令展示关键源码结构和内容。

• 课后实践要求：

  • 课后练习、课后实践、章节实践应有独立输入、任务说明和答案。
  • 实践题的代码开发、编译执行等操作步骤必须在 notebook 的 code cell 中执行。工程代码量大，仅需要修改几个关键文件时，工程可以存放在src对应小节目录中，待填写文件通过 code cell 中使用%%write命令提供写入操作。
  • 答案通过 code cell 中使用cat命令展示。

5. 课程开发上线体验规范

课程上线前必须验证目标硬件对应的在线体验环境，确保学习者可以直接打开 notebook 完成课程操作。

当前体验环境包括两类：

• learning-hub 的 notebook 在线体验环境。
• CANNLab，包括 910B/910C 云开发环境以及 950 尝鲜体验环境。

6. PR 准合入 Checklist

【免费下载链接】cann-learning-hubCANN 学习中心仓，支持在线互动运行、边学边练，提供教程、示例与优化方案，一站式助力昇腾开发者快速上手。项目地址: https://gitcode.com/cann/cann-learning-hub