Markdown 是内容源,不是首页导航
建议用时:25 分钟(含练习)
学习目标
能够区分原始 Markdown 内容、课程结构元数据、发布数据库与用户界面。
本节产出
一张知识内容发布分层图
核心知识:一篇笔记成为课程需要经过哪些层
Markdown 用简单文本符号表达标题、列表、链接、代码等结构,适合保存内容并比较版本。它让正文不必绑定某个编辑器,但并不保证在所有产品里呈现完全一致。表格、内部链接、嵌入和图表语法可能依赖扩展,发布时需要检查目标阅读器支持什么。
写作源与读者入口承担不同责任。作者可能按项目和概念组织笔记,读者则需要课程顺序、章节目标、前置知识和学习状态。如果把文件目录直接当作课程导航,历史草稿、重复标题和私人附件就可能一起暴露,也无法说明每节课应该学会什么。
图中每一步都可以保留来源追踪,但公开页面只应出现读者有权访问的信息。内部编辑记录可以帮助作者核对素材,公开引用则应指向可公开查阅的证据。两者可以关联,却不能直接用私人文件路径充当参考文献。
内容、结构、服务与界面分工
| 层次 | 负责什么 | 不应混入什么 |
|---|---|---|
| 内容源 | 解释、案例、图解与练习 | 未审核的私人信息 |
| 课程元数据 | 标题、顺序、目标与稳定标识 | 大量重复正文 |
| 发布服务 | 提供审核后的版本与访问规则 | 任意扫描并公开全部文件 |
| 阅读界面 | 导航、排版、进度与笔记 | 作者机器上的目录结构 |
稳定标识
稳定标识尤其重要。一节课标题调整或正文扩写后,学习者的笔记和完成记录仍应关联原来的课时。若系统每次导入都删除重建,内容看似更新成功,用户关系却可能丢失。发布设计需要明确哪些字段可以更新,哪些身份必须保持。
案例:把研究笔记改成独立课时
假设一份草稿只有“上下文很重要,参考前面的实验”两句话,并含有一张私人附件链接。作者自己知道实验背景,读者却不知道。改成课程时,应补齐问题、必要概念、可公开重现的例子、操作步骤和答案,并重新制作不依赖私人附件的图解。
可以把“前面的实验”改成完整的虚构案例:给模型同一任务,分别提供缺失资料和完整资料,比较输出中哪些部分能够核对。案例要说明它展示什么,也说明它不能证明所有模型在所有任务上的表现。这样读者无需拿到作者原始目录也能理解。
发布前做一次往返检查
先在正文源中核对标题层次和链接,再查看渲染页面,最后回到源文件检查修改是否准确保存。代码块应保持空格和换行;表格在窄屏应可读或独立滚动;图解需要文字替代与相邻解释;内部笔记链接应转换为公开页面链接或移除依赖。
图片存在于作者机器上,不代表发布服务能够读取。需要把允许公开的资源纳入交付产物,并检查实际页面返回。替代文字也不能只写“图片”,应说明图中表达的关系,让图未加载或使用辅助技术时仍能理解。
更新内容不等于重新创建课程
一次正文扩写通常只需要更新正文与配套资源。课程身份、章节关系、笔记和进度应保留。更新前可保存版本与变更清单,更新后核对预期课时数量、链接和页面内容,再保留回滚办法。即使不负责工程实现,作者也应该在交付清单中写明这些要求。
动手练习
- 用十行 Markdown 写一个小概念说明,包含标题、列表、公开链接和代码块。
- 为它补充课程结构信息,并画出四层发布流程。
- 模拟一次正文扩写,列出需要改变和必须保留的对象。
参考答案与推演
正文负责讲清概念,结构信息可单独记录课时标识、标题、顺序和目标。公开链接应在无私人权限的环境下可查阅;代码块应在阅读页保持可复制结构。若使用某个编辑器专属语法,就要确认发布端支持,或转换成通用表达。
扩写时可以更换解释与图解,但课时标识、用户笔记和进度关系应保持。一个合格检查记录不仅写“上传成功”,还会写页面实际显示了新内容、资源可用、旧链接仍能进入原课时,以及回滚对应哪个版本。
完成检查
- 能区分正文源、课程结构、发布服务与阅读界面。
- 读者无需访问作者私人目录就能完成学习。
- 图、表、代码与链接经过实际渲染检查。
- 内容更新保留稳定身份与学习者关系。
参考与来源
- CommonMark:Markdown Reference:核对基本 Markdown 结构。
- Obsidian:Internal links:理解内部链接与发布环境之间需要处理的差异。
附件
Markdown 是内容源,不是首页导航
3 道题 · 及格分 60 分