3 커밋 ea8e09f88b ... 318fbc9dcf

작성자 SHA1 메시지 날짜
  OpenCode 318fbc9dcf docs: 移除 code/ 层级 — 代码示例直接嵌入笔记正文 5 일 전
  OpenCode 8085950cdf docs: 明确代码整合的两层级结构 — code/归档 + md嵌入核心示例 5 일 전
  OpenCode 5cffac87c6 docs: 修正整理流程 — 先 raw 笔记再 wiki 知识页 5 일 전
1개의 변경된 파일39개의 추가작업 그리고 20개의 파일을 삭제
  1. 39 20
      docs/如何将他人文档整理为LLM-Wiki笔记.md

+ 39 - 20
docs/如何将他人文档整理为LLM-Wiki笔记.md

@@ -1,6 +1,8 @@
 # 如何将他人文档整理为 LLM Wiki 笔记
 
-> 以 STM32 学习笔记为例,总结从多源文档到结构化 Wiki 的完整流程。
+> 流程:源材料 → `raw/` 学习笔记(含代码 + 通俗解释) → `wiki/` 知识页。
+>
+> 以 STM32 学习笔记和 FreeRTOS 笔记为例。
 
 ---
 
@@ -337,26 +339,42 @@ git commit -m "<类型>: <摘要>"
 
 ## 8. 代码整合规范
 
-### 8.1 核心原则
+### 8.1 核心理念
 
-**不要把整个代码项目复制到笔记中**。而是:
+**不复制完整工程,只嵌入核心完整示例到笔记正文**
 
-1. 读 `freertos_demo.c`(或 `main.c`)提取核心示例
-2. 只保留关键代码段,删除重复的模板代码(任务配置、启动调度器等重复部分只保留一次)
-3. 每段代码必须有**通俗解释**(可以举生活中的例子)
-4. 复杂概念必须配**通俗类比**,确保小白能看懂
+```
+原始代码项目 (外部路径)          ← 源文件不动
+      │
+      ▼
+07-消息队列与队列集.md           ← 笔记中嵌入提取的核心代码
+      └─ void task1(void *pvParameters) { ... }
+      └─ void task2(void *pvParameters) { ... }
+```
 
-### 8.2 代码项目组织
+### 8.2 嵌入步骤
 
-原始代码项目(文件夹)整体复制到 `code/` 子目录,笔记中通过相对路径引用:
-```
-raw/Joplin/嵌入式+Linux/FreeRTOS学习笔记/
-├── code/
-│   ├── 09_消息队列/          ← 完整工程代码
-│   ├── 10_二值信号量/
-│   └── ...
-├── 07-消息队列与队列集.md    ← 只嵌入核心代码段
-└── 08-信号量与互斥信号量.md
+1. 读代码项目中的 `freertos_demo.c`(或 `main.c`),找到核心演示逻辑
+2. 提取**完整的函数/代码块**作为示例(保留可独立运行理解的关键部分)
+3. 删除重复的模板代码(任务配置宏定义、`freertos_start` 等通用部分只写一次即可)
+4. 每段代码必须有**通俗解释**(用生活中的例子类比)
+5. 复杂概念必须配**通俗类比**,确保小白能看懂
+
+示例(笔记中嵌入的格式):
+```c
+// ========== 核心示例:发送消息 ==========
+// 保留了完整函数体,删除了任务创建等模板部分
+void task1(void *pvParameters) {
+    uint8_t key = 0;
+    while (1) {
+        key = Key_Detect();
+        if (key == KEY1_PRESS) {
+            xQueueSend(queue1, &key, portMAX_DELAY);
+            // portMAX_DELAY = 队列满了就死等
+        }
+        vTaskDelay(500);
+    }
+}
 ```
 
 ### 8.3 嵌入式代码注意事项
@@ -379,9 +397,10 @@ flowchart TD
     F --> G[撰写讲解正文<br/>代码 + 通俗解释]
     G --> H[API 视觉模型验证图片]
     H --> I[精选+重命名图片到 assets/]
-    I --> J[整体复制代码项目到 code/]
-    J --> K[更新 wiki/index.md + log.md]
-    K --> L[git commit<br/>ingest/raw/wiki]
+    I --> J[创建 raw/ 学习笔记<br/>代码核心示例嵌入正文]
+    J --> K[从 raw 笔记提炼 wiki 知识页]
+    K --> L[更新 wiki/index.md + log.md]
+    L --> M[git commit<br/>ingest/raw/wiki]
 ```
 
 ---