知识文档体系规范
本文是 Dewyx Docs 的规范性基准,约束新增内容、既有内容重构、交互演示和自动化检查。它回答的不是“网站可以使用哪些组件”,而是“什么样的内容才可以作为可学习、可验证、可长期维护的知识发布”。
1. 规范状态与术语
| 项目 | 值 |
|---|---|
| 版本 | 1.3 |
| 状态 | 生效 |
| 适用范围 | 智能算法、系统工程、嵌入式、量化研究、音乐、摄影与知识库指南 |
| 规范归属 | README 管理站点定位、一级专栏、内容归属与路由;本文管理专栏内部结构、内容模型、教学质量和交互验收 |
本文使用以下约束词:
- 必须:不满足时不能标记为
learnable或verified; - 应当:默认遵守,偏离时需要在正文或评审记录中说明理由;
- 可以:按主题和维护成本选择。
README 与本文发生冲突时不得自行选择其一:应先按上述归属判断责任文件,再同步修正冲突,保证两个入口给出一致结论。
2. 建设目标
Dewyx Docs 定位为:
面向作者长期学习和复习的“知识地图 + 可执行教材 + 实践案例库 + 个人验证系统”。
它必须同时支持四种行为:
- 定位:快速知道一个主题位于哪里、依赖什么、之后学什么;
- 学习:通过可理解的例子、推导和解释建立心智模型;
- 验证:通过代码、实验、题目或案例证明已经掌握;
- 复用:在工程实践中快速查到约束、公式、接口和失效边界。
不以文章数量、更新频率、热门技术覆盖率或视觉组件数量作为主要目标。知识地图不替代教材正文,能构建的网站也不等于合格的知识内容。
3. 信息架构
全站保持六个一级专栏:智能算法、系统工程、嵌入式、量化研究、音乐和摄影。不按框架、语言、器材、单个项目或热点继续增加一级入口。
首页:知识门户
├── 专栏
│ ├── 专栏总览 index
│ ├── 知识地图 roadmap
│ ├── 章节总览 overview
│ │ ├── 概念课 lesson
│ │ ├── 实验 lab
│ │ ├── 参考 reference
│ │ └── 案例 case-study
│ └── 阶段复习 review
└── 知识库指南各层职责必须分开:
| 层级 | 负责 | 不负责 |
|---|---|---|
| 首页 | 专栏入口与知识库定位 | 展开具体知识 |
| 专栏总览 | 专栏范围、主线和边界 | 罗列所有细节 |
| 知识地图 | 依赖、顺序、完成度和分支 | 代替章节教学 |
| 章节总览 | 章节问题、学习单元和综合过关标准 | 压缩讲完全部主题 |
| 学习单元 | 教会一个可以验证的问题 | 同时承担整章百科 |
| 实验/案例 | 产生证据并连接实现 | 重新复制概念正文 |
| 参考 | 快速、准确地查找信息 | 引导初学者从头学习 |
4. 内容类型
每个页面必须有且只有一个主要类型。不同类型可以互相链接,不应在一个页面中无边界地混写。
4.1 overview:总览
回答“这一块为什么存在、包含什么、按什么顺序学习”。适用于专栏入口、知识地图和章节入口。
必须包含:
- 定位、目标读者和范围;
- 前置知识和依赖关系;
- 学习单元列表及推荐顺序;
- 明确不在本页展开的内容;
- 章节或阶段的综合过关标准;
- 当前建设状态。
总览页应链接详细内容,不应以一两段摘要假装已经讲完每个知识点。
4.2 lesson:概念课
回答“为什么、是什么、怎样推导、怎样确认理解”。这是知识学习的主要原子单位。
一篇 lesson 应只围绕一个主问题,通常可以在一次连续学习中完成。必须包含:
- 问题与动机;
- 前置知识和学习目标;
- 一个贯穿全文的最小例子;
- 直觉模型;
- 公式、结构或机制的逐步解释;
- 实现或可观察验证;
- 常见误解、适用条件和失效边界;
- 小结、自测和下一步。
4.3 lab:实验
回答“怎样亲手复现、观察和验证”。实验必须产生结果,而不是只列出以后可以做的事情。
必须包含:
- 实验目标和待验证命题;
- 环境、版本、资源和预计耗时;
- 固定输入、数据或随机种子;
- 可执行步骤;
- 预期输出或判断条件;
- 实际结果与解释;
- 常见失败、排查方法和环境差异;
- 清理、复现和关联 lesson。
4.4 reference:参考
回答“准确的定义、参数、shape、接口或规则是什么”。参考页以查找效率和一致性为优先。
必须包含:
- 适用范围和版本;
- 术语、符号或字段定义;
- 约束、不变量和默认值;
- 最小正确示例;
- 常见错误或易混淆项;
- 权威来源和关联 lesson/lab。
4.5 case-study:案例
回答“这些知识怎样解释一个真实项目、系统或研究结果”。案例不能把单次观察包装成普遍结论。
必须包含:
- 案例问题与选择理由;
- 来源、日期、版本、提交或数据范围;
- 使用了哪些通用知识;
- 观察、证据、推断和个人判断的明确区分;
- 可复现路径;
- 结果、局限和不能据此声称的内容;
- 回链到对应 lesson、lab 和 reference。
4.6 review:复习与验收
回答“是否已经掌握、薄弱点在哪里、下一步是什么”。
必须包含:
- 覆盖范围;
- 不查资料应能回答的问题;
- 推导、调试或实现任务;
- 答案、评分准则或自动测试入口;
- 典型错误与补学链接;
- 完成日期和后续复习建议。
智能算法专栏中标记为 learnable 或 verified 的 review 还必须接入 KnowledgeQuiz:至少覆盖一种客观题和一种开放题;答案默认隐藏,开放题以 rubric 自评而不是自动判分;同时保留可打印的静态题目与答案。答题记录只能默认保存在本地,不能在没有单独隐私设计时上传。
5. 页面元数据
所有内容页应使用以下 frontmatter。title、date、type、status、track 和 description 为通用必填字段;prerequisites、outcomes 和 estimated 在 lesson、lab、review 中必须提供。
---
title: 页面标题
date: YYYY-MM-DD
updated: YYYY-MM-DD
type: lesson # overview | lesson | lab | reference | case-study | review
status: outline # outline | draft | learnable | verified | stale
track: ai # ai | systems | embedded | quant | music | photography | guide
chapter: transformers
prerequisites:
- /ai/foundations/matrix-multiplication
outcomes:
- 能用具体数值解释一行乘一列怎样生成输出元素
estimated: 30min
categories:
- 智能算法
tags:
- Matrix
description: 一句话说明页面解决的问题和可获得的结果。
---约束:
title应描述知识问题或任务,不用“入门”“浅谈”等模糊词代替范围;description必须说明读者能解决什么问题;- 前置知识链接到最近的直接依赖,不重复整条祖先链;
- 学习目标必须可观察,避免“了解”“熟悉”等无法验收的表述;
- 环境相关内容必须有
updated、版本和验证日期; - 旧页面在迁移前可以暂缺新增字段,但不得直接标记为
verified。
6. 粒度与拆分规则
“完整知识块”以学习问题而不是学科名称判断。
满足任一条件时,应拆成章节总览和多个学习单元:
- 页面包含三个以上彼此具有独立前置关系的核心概念;
- 无法用同一个例子贯穿主要推导;
- 阅读、运行和自测不能在一次连续学习中完成;
- 实验需要独立环境、数据或维护周期;
- 页面同时承担教程、参考和案例三种以上职责;
- 小节需要独立被其他专栏或案例引用。
不得为了追求短文而机械拆分。只有定义差异、没有独立问题和验证方式的小节,应保留在同一 lesson 中。
推荐关系:
章节总览:序列、注意力与 Transformer
├── lesson:Q、K、V 为什么是一种可学习检索
├── lesson:单头注意力怎样完成匹配、约束与读取
├── lab:从零实现单头注意力
├── lesson:多头为什么需要 reshape 和 transpose
├── lesson:Attention 怎样进入 Transformer Block
├── reference:Attention shape 与符号表
├── case-study:MiniMind 的 GQA 与 repeat_kv
└── review:从 [B,T,C] 推导完整前向传播7. Lesson 教学闭环
每篇 lesson 应遵循同一个学习节奏:
定位 → 提问 → 建模 → 推导 → 操作 → 验证 → 反思 → 连接7.1 定位
开头必须让读者在一分钟内知道:
- 为什么现在学习它;
- 已经依赖了什么;
- 学完后具体能做什么;
- 本页不解决什么。
7.2 最小例子
优先使用可以手算、画出和运行的最小数据。例子必须贯穿公式、图、代码和自测,避免每个媒介重新换一套变量。
7.3 多重表示
重要概念应尽量同时提供:
- 自然语言解释;
- 数学或结构表达;
- 具体数值例子;
- 可运行代码或可操作演示。
这些表示必须使用一致的符号、颜色、变量和数据,并明确说明彼此如何对应。
7.4 验证与反思
概念题、模拟运行、独立实现、真实硬件验证必须分开记录。改变训练数据后的验收应检查新分布与不变量,不能沿用旧答案白名单;审批 mock 必须由显式外部事件恢复;教学状态机显示必须与内部状态一致。实验变式与拒绝/取消路径应进入相同源码的自动化验证。
读者完成后至少能够:
- 预测一个输入变化会产生什么结果;
- 解释关键步骤为什么存在;
- 识别一个典型错误;
- 在不复制正文的情况下完成最小任务。
自测题必须有答案、提示、测试或明确评分标准,不能只留下开放问题。
7.5 学科初学者的认知递进
技术专栏默认读者具备数学与线性代数基础,不要求重新教授基础算术。音乐与摄影专栏默认读者尚未接受系统训练,但能够按说明完成听辨、演奏、观察、拍摄和复盘任务。初学者指尚未掌握目标对象或相关工具的读者;语言、运行环境、乐器操作和素材管理各有明确补学入口。
面向初学者的章节必须按照“对象从哪里来 → 单体怎样闭环 → 怎样扩展规模 → 怎样进入完整系统”的顺序组织。不得以作者熟悉公式为理由,要求读者自行补齐中间桥梁。
必须满足:
- 先解释来源,再使用符号。 首次使用 token、embedding、张量、状态或事件等对象时,先说明它从什么输入产生、一个元素或一行代表什么,再进入公式和组件。
- 先完成最小闭环,再增加轴和变体。 单样本、单层、单头或单节点尚未完整推导和验证前,不得把 batch、多头、分布式、缓存或工程优化放进必修主线。
- 一页只承担一个认知跃迁。 角色课不能同时替代完整计算课,shape 课不能同时承担数值推导,概念课不能顺带变成工程变体百科。
- 同一示例保持计算契约不变。 公式、动画、手算、代码和自测使用同一组输入时,scale、mask、归一化轴、随机种子等规则必须一致;若为了消融而改变规则,必须先给出基线结果,再明确标成反事实实验。
- 语义表示与数值表示必须对齐。 自然语言中的对象应能定位到图或矩阵中的行、列、节点;教学用数字若不是模型真实输出,必须明确说明它是人为构造的最小坐标。
- 核心主线与进阶扩展分层。 初学者过关标准只考查本章主线;实现变体、性能优化、历史背景和前沿术语进入进阶小节、reference 或 case-study。
- 章节导航只有一条主路径。 总览顺序、侧边栏、每页 prerequisites、“下一步”和 review 覆盖范围必须一致,不能让读者在局部链接中跳过必修页。
章节完成前应执行一次“空白读者回放”:假设读者只掌握已声明的直接前置,逐页记录每个新术语的首次出现、每次数学规则变化和每个下一步链接。需要依靠后文知识才能理解前文,或同一结果在未声明条件变化时出现两个答案,都视为结构缺陷。
8. 交互与动画规范
交互组件首先按认知任务设计,再选择技术库。
出现公式并不自动意味着需要动画。只有当时间顺序、空间对应或状态变化本身属于学习目标时,才应引入交互;否则优先使用正文、公式、表格或静态图。
| 认知任务 | 目的 | 常见表达 |
|---|---|---|
| 变换 | 观察对象结构怎样变化 | 前后并列、映射线、稳定位置 |
| 计算 | 观察输入怎样生成输出 | 操作数高亮、公式同步、逐项累加 |
| 比较 | 理解方案差异和权衡 | 同尺度并排、差异标注、控制变量 |
| 模拟 | 理解参数对动态系统的影响 | 参数控件、即时反馈、基线与重置 |
| 优化 | 理解状态怎样逐轮接近目标 | 轨迹、当前步、目标和误差 |
| 追踪 | 理解信息、梯度或事件的路径 | 路径高亮、因果顺序和状态说明 |
Mermaid、ECharts、D3、Konva、Motion、Vue Flow、WaveDrom 和 Three.js 只是实现选择,不能代替教学设计。
8.1 演示契约
每个交互演示必须先定义:
学习问题:读者要理解什么?
输入对象:哪些内容在开始前已经存在?
状态:当前步骤完整描述什么?
动作:读者或播放器一次改变什么?
输出对象:变化怎样被观察和验证?
完成条件:读者看到什么才算闭环?
静态回退:无脚本或减少动态效果时怎样获得同样信息?8.2 视觉连续性
- 输入、输出和关键对象应尽量保持固定位置;
- 一步只表达一个主要变化;
- 变化前后应同时可比较,或提供清晰的运动路径;
- 当前参与计算的源、操作和目标必须同步高亮;
- 颜色不能是唯一编码,同时使用标签、形状、位置或文字;
- 公式、数值、图形和说明必须指向同一个状态;
- 不得用淡入淡出代替数据流、轴移动或计算过程。
8.3 控制与状态
分步动画应当提供:
- 上一步、下一步、播放/暂停、重置;
- 当前步骤与总步骤;
- 明确的开始状态和完成状态;
- 播放中仍可暂停和单步查看;
- 必要时提供速度控制;
- 每一步说明“发生了什么”和“为什么”。
控件必须可发现,不依赖读者猜测图形可以点击或拖动。
8.4 无障碍与降级
- 尊重
prefers-reduced-motion; - 减少动画时不能丢失状态关系,只能移除非必要运动;
- 所有操作支持键盘并具有可见焦点;
- 数字步骤按钮必须有具体名称,不能只向辅助技术暴露“1、2、3”;
- 状态变化使用适度的
aria-live或等价说明; - Canvas 内容必须有正文、表格、公式或静态图回退;
- 自动播放不得成为获取信息的唯一方式。
8.5 动画完成标准
动画只有在读者可以回答以下问题时才算完成:
- 变化前有哪些对象?
- 当前哪几个对象参与操作?
- 这一步改变了什么,没有改变什么?
- 当前结果从哪里得到?
- 下一步为什么成立?
- 整个过程最终解决了什么问题?
8.6 模型计算与矩阵动画
智能算法中的线性层、卷积、注意力、归一化、残差、反向传播和优化循环经常共享同一种困难:公式很短,但读者看不见“哪个对象以什么 shape 进入哪一步、哪些行列发生运算、结果写到哪里”。这类内容应采用统一的模型计算可视化,而不是只把步骤编号、公式结果或几张数值卡片依次切换。
满足以下任一条件时,应当评估矩阵或模型层动画;前两项属于核心学习目标时,标记为 learnable 或 verified 的 lesson 必须提供动画或等价的逐步交互:
- 读者必须理解行、列、轴、token、通道或 batch 之间的空间对应;
- 同一对象连续经历投影、转置、reshape、mask、归一化或聚合;
- 一个输出元素来自多个输入元素的配对、累加或加权;
- 模型层的输入、参数、激活和输出职责容易混淆;
- 只看最终数字无法定位 shape、广播、遮罩轴或梯度方向错误。
统一视觉语法如下:
| 对象 | 必须表达 | 推荐表达 |
|---|---|---|
| 张量或矩阵 | 名称、shape、轴含义、当前数值 | 格子矩阵;较大张量可抽样并标注省略 |
| 参数 | 与输入和激活不同的身份 | 独立标签与语义颜色,不画成输入副本 |
| 运算 | 输入、操作符和输出的对应关系 | 固定位置上的乘、加、箭头或运算节点 |
| 行列乘加 | 当前输入行、输入列和目标格 | 三者同步高亮,必要时显示当前乘积与部分和 |
| 轴变换 | 变化前后的轴顺序与 shape | 轴标签移动或前后并列,不能只更新数字 |
| mask | 哪个位置非法以及为什么 | 非法格同时使用符号、文字和颜色 |
| 概率或权重 | 归一化轴、和为 1 的范围 | 行内强度或比例,并保留准确数值 |
| 输出 | 来源和最终 shape | 与源对象保持可追踪的空间关系 |
模型计算动画还必须满足:
- 对象稳定:同一矩阵在相邻步骤保持位置;确需移动时必须显示路径,不能在新位置突然重绘。
- 语义步骤:阶段入口使用“Q 投影、点积、遮罩、读取 V”等名称,不能以孤立的数字代替学习含义。
- 局部聚焦:一步只强调一个主要操作;行列乘法按“源行 + 源列 → 目标格”形成闭环。
- 全局上下文:非当前对象可以降低强调,但不能全部消失;读者应始终知道当前步骤位于完整流水线哪里。
- 确定性数值:正文、公式、动画、代码和自测共享同一组最小输入;近似值必须采用一致精度。
- 职责可区分:输入、参数、中间激活、权重、梯度和输出不得仅靠变量名区分;颜色只能作为辅助编码。
- 主题一致:亮暗主题分别保证背景、网格、文本、高亮和禁用状态的对比度,不允许亮色主题沿用深色代码画布。
- 可控播放:默认允许单步查看;自动播放不能跳过关键中间状态,行列扫描速度应足以读清对应关系。
- 响应式策略:优先重排或缩放;如果缩放会使矩阵标签不可读,可以横向滚动,但必须保证阶段控件始终可见。
- 静态等价:正文或折叠区必须保留完整计算路径、关键输入输出和可手算结论。
- 可编辑实验:需要研究参数敏感性时,应编辑输入或模型参数并实时重算派生结果;中间答案保持只读,同时提供范围校验与恢复基线。
可编辑演示还应遵循“原位操作”:
- 输入值和参数应在图中对应对象上直接修改,不在组件底部重复搭建一套脱离上下文的表单;
- Canvas 可以叠加原生 DOM 输入框,但不能自己模拟文本编辑器;
- 同一输入在图中重复出现时必须同步修改,并明确它们引用同一对象;
- 编辑时暂停自动播放,保留当前阶段,让读者立即观察因果变化;
- 派生矩阵只读,避免学习者把“改输入”和“填写答案”混为一谈;
- 仅当对象过大、批量粘贴或高级配置无法原位完成时,才可以提供独立编辑器。
静态回退用于无障碍和无脚本场景,不等于每个组件底部都要显示“静态路径”。如果页面正文已经完整覆盖同一结论,回退说明应提供给辅助技术但不重复占用视觉空间;只有回退内容包含正文没有的必要信息时,才公开显示。
以下情况不应强行使用 Canvas:
- 只有一个静态公式,且没有需要追踪的空间或时间关系;
- 普通数据比较可以用表格或 ECharts 更准确表达;
- 模型拓扑或依赖关系以 SVG、Vue Flow 或 Mermaid 更清楚;
- 动画只能制造移动效果,却不能帮助回答本节学习问题。
8.7 模型动画的文档嵌入契约
动画不是插图附件,而是 lesson 教学闭环中的一次观察实验。包含模型计算动画的页面必须按以下顺序组织:
观察任务
→ 固定输入、符号和颜色
→ 可操作动画
→ 读图检查点
→ 至少一次手算或代码验证
→ 改变一个变量的反事实问题
→ 静态结论与下一步- 动画前必须告诉读者“要盯住什么”,不能只写“如下图所示”;
- 动画中的数据必须在正文先定义,或在组件起始状态中完整显示;
- 动画后必须解释发生了什么、什么没有改变,以及这一观察证明了什么;
- 手算或代码验证必须复用动画输入,不能另换一套方便计算的例子而不说明;
- 一个动画只服务一个主要学习问题;完整模型应拆成层级导览和若干局部动画;
- 同一动画被三篇以上页面复用时,应抽成公共场景或组件,不复制绘制代码;
- 组件实现、测试与复用方式遵循交互式知识组件。
9. 代码、实验与证据
- 正文中的关键代码必须能运行,或明确链接到仓库内可运行版本;
- 代码、文章输出和自动化测试应来自同一事实来源,避免手工维护三份结果;
- 教学示例优先使用确定性输入、固定随机种子和小数据;
- 输出必须展示与当前知识点有关的值,不能只以“程序没有报错”作为验证;
- 实验应区分预期、实际观察和解释;
- 任何性能、质量或行为结论都必须记录环境、版本、数据范围和日期;
- 外部项目案例记录代码身份,不把当前实现描述成永久事实;
- 无法自动验证的内容应提供人工检查步骤。
9.1 音乐与摄影的实践证据
音乐与摄影包含无法由自动测试完整判断的能力。这里的“可验证”要求证据可复查、结论边界清楚,不要求把审美或表现力压缩成一个客观分数。
- 音乐练习可以保存本人录音、节拍或音高记录、曲谱标注、老师反馈和带 rubric 的自评;合成器播放、示范音频和网页状态测试只证明教学工具可用,不证明本人已经会演奏。
- 摄影练习可以保存原始照片、拍摄参数、处理步骤、成片、选片理由、老师反馈和带 rubric 的复盘;示例图和参数模拟只证明教程可观察,不证明本人已经完成拍摄。
- 老师反馈必须记录来源、日期和对应作品;主观判断必须写明判断者、依据和不确定处。
- 使用外部录音、照片或参考作品时必须记录作者、来源、许可证或使用依据,并区分原作与本站的裁切、调色、标注等改动。
- 自动检查可以验证文件、元数据、数值约束和交互状态,但不得自动宣称演奏表现、构图质量或审美成熟度已经合格。
10. 内容成熟度
所有内容使用统一状态:
| 状态 | 含义 | 发布要求 |
|---|---|---|
outline | 只有范围、目录或待办 | 可以出现在 roadmap,不作为已完成课程 |
draft | 已有正文但学习闭环不完整 | 明确显示草稿状态 |
learnable | 模板完整,可由目标读者独立完成 | 通过人工内容检查 |
verified | 代码、链接、结果和教学验收均已完成 | 通过自动检查和复核 |
stale | 曾经可用,但环境或事实可能过期 | 显示警告并进入复核队列 |
状态描述知识内容的可信度,不描述作者投入了多少时间,也不描述本人技能熟练度。页面较长、构建成功或已经发布都不能自动获得 learnable 或 verified;页面达到 verified 也不能推出本人已经熟练演奏、听辨、拍摄或完成审美判断。个人技能进度应在练习记录或作品复盘中以日期、任务和证据单独记录。
11. 导航、链接与命名
- 专栏侧边栏展示章节和高价值学习单元,不把每个辅助页面都提升到同一层;
- roadmap 展示知识依赖,章节总览展示学习顺序,两者不能混为一个列表;
- lesson 链接直接前置与下一步,case-study 反向链接所用知识;
- URL 使用稳定的知识语义,不使用日期、临时任务名或当前框架版本;
- 章节总览沿用已有 URL 时,应把详细内容迁到子页面并保留入口解释;
- 改名或拆分时检查旧链接,必要时保留迁移提示;
- 一份知识只保留一个主要正文,其他位置通过摘要和链接复用。
12. 质量门禁
12.1 人工评审
每次新增或重构内容必须检查:
- 页面类型是否唯一且正确;
- 目标读者、前置知识和学习结果是否明确;
- 粒度是否能形成一次学习闭环;
- 例子是否贯穿文字、公式、图和代码;
- 观察、事实、推断和判断是否分开;
- 自测或实验是否有可验证结果;
- 边界、失败方式和下一步是否完整;
- 新增内容是否接入 roadmap、章节入口和相关反向链接。
12.2 自动检查
项目应逐步建立以下检查:
- frontmatter schema 和枚举值;
- 各内容类型的必需字段与章节;
- 标题层级、重复标题和内部链接;
- 代码示例、测试和输出快照;
- 图片替代文本与资源有效性;
- 交互组件的静态回退、键盘入口和步骤元数据;
- 环境相关内容的验证日期和过期提示;
- roadmap 节点与实际页面、成熟度之间的一致性。
自动检查负责阻止结构性退化,不能代替教学评审。
13. 现有内容迁移规则
迁移采用“黄金样例优先”,不一次性批量改写全站。
第一阶段:建立标准样例
优先处理智能算法第 0、2、3 章,选择一条连续路径:
矩阵乘法
→ 张量轴、reshape 与 transpose
→ Q、K、V
→ mask 与 softmax
→ 加权 V
→ 完整单头注意力实验
→ 多头与 GQA 案例其中“矩阵乘法”和“完整注意力”分别作为计算动画与综合实验的黄金样例。
第二阶段:大文章角色收敛
- 保留既有章节 URL;
- 将大文章调整为
overview; - 把可独立学习、验证和引用的内容迁到 lesson/lab/reference;
- 在新旧页面之间建立双向链接;
- 未完成页面标记真实成熟度。
第三阶段:推广到其他专栏
- 系统工程重点采用 explanation、lab、case-study;
- 嵌入式重点采用 reference、lab、波形和故障案例;
- 量化研究重点采用 lesson、lab、case-study,并强化点时数据、证据阶段和失效边界;
- 音乐重点采用 lesson、lab、review,以听辨、演奏、录音和反馈构成闭环;
- 摄影重点采用 lesson、lab、case-study,以观看、实拍、选片和复盘构成闭环;
- 只有黄金样例验证有效后,才抽象公共模板和组件。
14. 完成定义
一篇内容只有同时满足以下条件,才可以标记为 verified:
- 位于明确的专栏、章节和知识地图节点;
- 页面类型、粒度和必需元数据符合本规范;
- 目标读者能够理解前置条件和完成目标;
- 核心结论至少有一种可复查证据;
- 音乐或摄影页面明确区分内容成熟度与本人技能熟练度,并标注实践证据的来源;
- 页面中存在的公式、图、动画、代码和文字不存在语义冲突;
- 代码与链接通过自动检查;
- 如包含动画,动画具有静态回退并通过键盘与减少动态效果检查;
- 自测、实验或任务有答案、测试或评分标准;
- 明确说明适用条件、失效边界和下一步;
- 完成人工教学评审,并记录最近验证日期。
15. 设计参考
本规范综合以下公开实践,并按个人长期知识库的目标做了取舍:
- Diátaxis:区分教程、操作指南、参考和解释;
- GitHub Docs content model:按内容类型约束结构与发布;
- Dive into Deep Learning:将解释、数学、图、可运行代码、总结和练习放在同一学习系统;
- Microsoft ML for Beginners:稳定的课程节奏、知识检查、挑战和作业;
- Hugging Face Course:章节、小节、前置知识、学习时间与 Notebook 的连接;
- OSSU Computer Science:依赖、投入时间、核心/选修和最终项目;
- roadmap.sh:交互式知识路径和节点入口;
- System Design Primer:学习模式、稳定解题模板和案例;
- Seeing Theory:用可操作可视化辅助抽象概念理解。
这些项目是设计参考,不是本站目录或内容的直接来源。引入外部知识时仍需核对原始资料、许可证、版本和适用边界。