代码库到课程

文档 社区

技能解读

当前原文的自动摘译,尚未人工审校。

首轮欢迎

当技能首次触发并且用户尚未指定代码库时,请介绍自己并解释您的工作:我可以将任何代码库转变为交互式课程,教授其工作原理 - 不需要编码知识。只需将我指向一个项目: - 本地文件夹 - 例如,“将 ./my-project 变成课程” - GitHub 链接 - 例如,“从 https://github.com/user/repo 制作课程”

这是给谁的

目标学习者是“vibe 程序员”,即通过用自然语言指导人工智能编码工具来构建软件的人,无需接受传统的计算机科学教育。他们可能自己构建了这个项目(没有查看代码),或者他们可能在 GitHub 上发现了一个有趣的开源项目并想了解它是如何构建的。不管怎样,他们还不明白幕后发生了什么。

为什么这种方法有效

这项技能颠覆了传统的计算机科学教育。旧的模式是:多年来记住概念→最终构建一些东西→最终明白要点(大多数人在第3步之前就放弃了)。这个模型是:首先构建一些东西→体验它的工作原理→现在了解它是如何工作的。学习者已经掌握了传统学生所没有的背景——他们已经“使用”了该应用程序,他们知道它的作用,他们甚至可能用自然语言描述了它的功能。该课程在他们所在的地方遇到了他们:“你知道你点击的按钮吗?这就是当你点击它时会发生什么。”

第一阶段:代码库分析

在编写课程 HTML 之前,请深入了解代码库。读取所有关键文件,跟踪数据流,识别“角色”(主要组件/模块),并映射它们的通信方式。彻底的学习是有回报的——你理解得越多,课程就越好。提取内容: 主要“参与者”(组件、服务、模块)及其职责 主要用户旅程(当有人端到端使用应用程序时会发生什么)

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
文档
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@zarazhangrui · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
需简单配置
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
  • 命令执行
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第一阶段:代码库分析

在编写课程 HTML 之前,请深入了解代码库。读取所有关键文件,跟踪数据流,识别“角色”(主要组件/模块),并绘制它们的通信方式。彻底的学习是有回报的——你理解得越多,课程就越好。提取内容: 主要“参与者”(组件、服务、模块)及其职责 主要用户旅程(当有人端到端使用应用程序时会发生什么)

02
第二阶段:课程设计

将课程分为 4-6 个模块。大多数课程需要 4-6 个。仅当代码库确实具有许多值得教授的不同概念时才转到 7-8。更少、更好的模块胜过更多、更薄的模块。弧线始终从学习者已经知道的内容(面向用户的行为)开始,然后向他们不知道的内容(下面的代码)移动。将其视为放大:从体验开始,然后逐渐剥离层次。

03
阶段 2.5:模块简介(仅限复杂代码库)

对于复杂的代码库,请在编写任何 HTML 之前为每个模块编写一个简介。这是实现并行编写的关键步骤——每个简报都为代理提供了所需的一切,而无需重新阅读代码库。阅读`references/module-brief-template.md`了解模板结构。阅读`references/content-philosophy.md`,了解指导简短写作的内容规则。对于每个模块,请向`course-name/briefs/0N-slug.md`写一份摘要,其中包含:

04
第 3 阶段:构建课程

课程输出是一个目录,而不是单个文件。所有 CSS 和 JS 都是预先构建的参考文件 - 永远不要重新生成它们。您的工作只是编写 HTML 内容。输出结构: 步骤 1(两个路径):设置 — 创建课程目录。使用“读 + 写”逐字复制这四个文件(不重新生成其内容): `references/styles.css` → `course-name/styles.css` `references/main.js` → `course-name/main.js`

05
第 4 阶段:审核和开放

运行`build.sh`后,在浏览器中打开`index.html`。让用户了解所构建的内容,并询问有关内容、设计和交互性的反馈。

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。