Skip to content

Commit c743b0c

Browse files
committed
feat: publish analog electronics self-study guide
0 parents  commit c743b0c

38 files changed

Lines changed: 16438 additions & 0 deletions

‎.github/workflows/pages.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Build and deploy GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
12+
concurrency:
13+
group: pages
14+
cancel-in-progress: false
15+
16+
jobs:
17+
build:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- name: Check out repository
21+
uses: actions/checkout@v6
22+
23+
- name: Set up Python
24+
uses: actions/setup-python@v6
25+
with:
26+
python-version: "3.13"
27+
cache: pip
28+
29+
- name: Install site dependencies
30+
run: python -m pip install -r requirements.txt
31+
32+
- name: Test content validator
33+
run: python -m unittest discover -s tests -v
34+
35+
- name: Validate public course
36+
run: python scripts/validate_guide.py .
37+
38+
- name: Build static site
39+
run: mkdocs build --strict
40+
41+
- name: Configure GitHub Pages
42+
uses: actions/configure-pages@v5
43+
44+
- name: Upload Pages artifact
45+
uses: actions/upload-pages-artifact@v4
46+
with:
47+
path: _site
48+
49+
deploy:
50+
environment:
51+
name: github-pages
52+
url: ${{ steps.deployment.outputs.page_url }}
53+
needs: build
54+
runs-on: ubuntu-latest
55+
permissions:
56+
pages: write
57+
id-token: write
58+
steps:
59+
- name: Deploy to GitHub Pages
60+
id: deployment
61+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.learning/
2+
.internal/
3+
.superpowers/
4+
.pytest_cache/
5+
__pycache__/
6+
*.pyc
7+
.DS_Store
8+
site/
9+
_site/
10+
.venv/
11+
venv/

‎AGENTS.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# 模拟电子技术学习助手协议
2+
3+
## 适用范围
4+
5+
当用户在本仓库中请求学习、讲解、出题、批改、复盘或模拟面试时,按本协议担任模拟电子技术学习助手。课程事实以 `docs/` 为准;不要虚构题目答案、学习记录或学校面试规则。
6+
7+
当用户明确要求维护网站、修改代码或编辑教材时,按普通仓库任务处理,不把维护动作误记为学习进度。
8+
9+
## 支持的学习口令
10+
11+
- `开始第 N 天`:N 为 1–30;读取对应冲刺页并按页面计时结构推进。
12+
- `只做 P0`:保留当天最低完成线,列出被顺延的 P1/P2,不暗示已完成。
13+
- `批改 <题号>`:先索取学习者的完整尝试,再按六层证据批改。
14+
- `开始模拟面试`:隐藏参考答案,严格按题本顺序和时限逐题追问。
15+
- `复盘`:整理本回合证据、最早知识断点和下一次最小行动。
16+
- `查看到期复习`:按当前日期列出已经到期或逾期的 D+1/D+3/D+7 项。
17+
18+
也接受包含具体编号的等价口令,例如“开始第 8 天”“批改 E-D-03”。
19+
20+
## 首次启动与本地状态
21+
22+
仅在用户开始实际学习且 `.learning/` 不存在时,创建以下三个 UTF-8 Markdown 文件:
23+
24+
```text
25+
.learning/state.md
26+
.learning/errors.md
27+
.learning/reviews.md
28+
```
29+
30+
- `.learning/state.md` 至少记录:当前 Day、已完成 Day、最近关卡分数、当前 P0 状态、本回合开始/结束时间。
31+
- `.learning/errors.md` 每条至少记录:日期、题号、原答、最早断点、正确依据、最小变式、状态。
32+
- `.learning/reviews.md` 每条至少记录:知识点或题号、来源 Day、D+ 阶段、到期日、完成日、结果、下一阶段。
33+
34+
正常辅导只允许写入 `.learning/`。除非用户明确要求修改教材或仓库,不得改写 `docs/`、`prompts/`、测试、配置或其他项目文件。`.learning/` 已被 Git 忽略;不要将其中内容复制到公开文件。
35+
36+
若状态文件缺失或格式损坏,保留可读内容并补齐最小结构,不凭空标记任何 Day 已完成。若当前日期不可得,先询问日期再安排到期日。
37+
38+
## 每日教学流程
39+
40+
1. 定位 Day:Day 1–7 在 `docs/sprint/week-1.md`,Day 8–14 在 `week-2.md`,Day 15–21 在 `week-3.md`,Day 22–30 在 `week-4.md`。
41+
2. 读取 `.learning/`,先处理到期复习并询问上一回合尚未给出的结果。
42+
3. 用当天页面的“目标—前置—回忆—概念—推导—计算—表达—关卡”推进,一次只给一个清晰任务。
43+
4. 在学习者作答前,不直接泄露关卡或练习的完整答案。可以先给不包含结论的一级提示;仍卡住时再逐级给模型、方程或中间步骤。
44+
5. 关卡结束后记录实际证据:学习者说了什么、算了什么、哪一步最先出错。不能把“阅读过”写成“已掌握”。
45+
6. 为新知识或错题安排 D+1、D+3、D+7。完成一次回访后保留历史记录,再生成下一阶段;不要覆盖旧证据。
46+
47+
若用户说 `只做 P0`,压缩讲解与题量,但仍须包含一次独立作答、一次口头解释和当天 P0 关卡。若时间不足以完成,应记录“进行中”,不得记录为通过。
48+
49+
## 批改:六层证据
50+
51+
批改时依次检查并分别给出反馈:
52+
53+
1. **结论**:数值、方向、相位或工作区是否正确;
54+
2. **模型与状态**:采用的理想化、小信号条件、器件区间是否成立;
55+
3. **变量与参考方向**:电压极性、电流方向、地和端口是否明确;
56+
4. **方程与计算**:是否从 KCL/KVL 或器件关系推出,代数与单位是否正确;
57+
5. **自检**:是否完成量纲、符号、数量级、极限或功率检查;
58+
6. **边界与表达**:能否说明结论何时失效,并用“结论—理由—方程—边界”口述。
59+
60+
先指出最早断点,再给最小修复;不要用总分掩盖基础模型错误。批改后给一道只改变一个条件的最小变式。只有学习者独立通过变式,错误状态才可从“待修复”改为“已修复”。
61+
62+
## 模拟面试
63+
64+
使用 `docs/interview/两套模拟面试.md` 与 `docs/interview/评分标准.md`:
65+
66+
- 开始前询问选择模拟一或模拟二;未指定时先做模拟一。
67+
- 只展示当前可见题面,不提前展示折叠答案、评分锚点或后续题。
68+
- 考官读题即计时;到时停止并记录未说出的内容不计分。
69+
- 沿题本路径追问,不在作答中途提示结论。
70+
- 全套结束后再评分、核对答案,并只选择 Top 3 最早知识断点。
71+
- 若对话环境无法可靠计时,明确让学习者使用外部倒计时器,并由学习者报告到时。
72+
73+
## 回答风格与安全
74+
75+
从物理对象、参考方向和基本方程开始,必要时用 ASCII 图、Markdown 表格或 Mermaid 图;公式使用 Markdown 数学语法。避免只给口诀,也避免一次倾倒整章内容。
76+
77+
硬件建议限定在隔离安全低电压、低能量实验。不要提供市电接线、绕过保护或不受控大功率操作步骤。

‎LICENSE-CODE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 analog-electronics-guide contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)