Merge pull request #9 from quanru/feat/add-self-explanatory

Add self-explanatory comments to the examples
quanru · Jul 8, 2023 · 45ba12f · 45ba12f
2 parents 676b68b + 9620312
commit 45ba12f
Show file tree

Hide file tree

Showing 27 changed files with 332 additions and 254 deletions.
diff --git a/1. Projects/分享-2023 WOT 分享会/README.md b/1. Projects/分享-2023 WOT 分享会/README.md
@@ -5,7 +5,7 @@ tags:
 ---
 
 # README
-
+%%设置项目截止日期，及其结果描述%%
 - [x] #分享/WOT 截止日期 📅 2023-06-17 ✅ 2023-06-17
 - #分享/WOT 结果描述
 	- 时间：[[2023-06-17]] 周六
@@ -25,11 +25,13 @@ tags:
 	- rspack/modern.js/diagnostics tool
 
 ## 任务
+%%根据当前文件的 [Metadata](https://help.obsidian.md/Editing+and+formatting/Metadata) 的 tags 字段查询任务，从所有的笔记中提取%%
 ```periodic-para
 TaskListByTag
 ```
 
 ## 列表
+%%根据当前文件的 [Metadata](https://help.obsidian.md/Editing+and+formatting/Metadata) 的 tags 字段查询子弹列表，从所有的笔记中提取%%
 ```periodic-para
 BulletListByTag
 ```
diff --git a/2. Areas/工作/README.md b/2. Areas/工作/README.md
@@ -7,11 +7,13 @@ tags:
 # README
 
 ## 任务
+%%根据当前文件的 [Metadata](https://help.obsidian.md/Editing+and+formatting/Metadata) 的 tags 字段查询任务，从所有的笔记中提取%%
 ```periodic-para
 TaskListByTag
 ```
 
 ## 列表
+%%根据当前文件的 [Metadata](https://help.obsidian.md/Editing+and+formatting/Metadata) 的 tags 字段查询子弹列表，从所有的笔记中提取%%
 ```periodic-para
 BulletListByTag
 ```
diff --git a/2. Areas/知识管理/README.md b/2. Areas/知识管理/README.md
@@ -10,11 +10,13 @@ tags:
 - 目的：聚焦项目和领域，完成年度目标
 
 ## 任务
+%%根据当前文件的 [Metadata](https://help.obsidian.md/Editing+and+formatting/Metadata) 的 tags 字段查询任务，从所有的笔记中提取%%
 ```periodic-para
 TaskListByTag
 ```
 
 ## 列表
+%%根据当前文件的 [Metadata](https://help.obsidian.md/Editing+and+formatting/Metadata) 的 tags 字段查询子弹列表，从所有的笔记中提取%%
 ```periodic-para
 BulletListByTag
 ```
diff --git a/PeriodicNotes/2023/2023-Q1.md b/PeriodicNotes/2023/2023-Q1.md
@@ -1,8 +1,11 @@
 > 制定季度目标
 
+%%分别从要事维度和角色维度设定目标%%
+
 # 目标
 
 ## 要事维度
+%%领域的本季快照%%
 1. [[2. Areas/工作/README|工作]]
 2. [[2. Areas/知识管理/README|知识管理]]
 
@@ -18,15 +21,18 @@
 
 # 复盘
 ## 项目列表
+%%本季经历的项目列表，从本季的日记中提取，并自动统计项目耗时占比%%
 ```periodic-para
 ProjectListByTime
 ```
 ## 本季收集
+%%本季收集的任务列表，从本季的日记中提取%%
 ```periodic-para
 TaskRecordListByTime
 ```
 
 ## 本季完成
+%%本季完成的任务列表，从所有的笔记中提取%%
 ```periodic-para
 TaskDoneListByTime
-```
+```
diff --git a/PeriodicNotes/2023/2023-Q2.md b/PeriodicNotes/2023/2023-Q2.md
@@ -3,6 +3,7 @@
 # 目标
 
 ## 要事维度
+%%领域的本季快照%%
 1. [[2. Areas/工作/README|工作]]
 2. [[2. Areas/知识管理/README|知识管理]]
 
@@ -18,15 +19,18 @@
 
 # 复盘
 ## 项目列表
+%%本季经历的项目列表，从本季的日记中提取，并自动统计项目耗时占比%%
 ```periodic-para
 ProjectListByTime
 ```
 ## 本季收集
+%%本季收集的任务列表，从本季的日记中提取%%
 ```periodic-para
 TaskRecordListByTime
 ```
 
 ## 本季完成
+%%本季完成的任务列表，从所有的笔记中提取%%
 ```periodic-para
 TaskDoneListByTime
-```
+```
diff --git a/PeriodicNotes/2023/2023.md b/PeriodicNotes/2023/2023.md
@@ -1,8 +1,11 @@
 > 制定年度目标
 
+%%分别从要事维度和角色维度设定目标%%
+
 # 目标
 
 ## 要事维度
+%%本年经历的领域列表，从本年的季记中提取%%
 ```periodic-para
 AreaListByTime
 ```
@@ -17,15 +20,18 @@ AreaListByTime
 
 # 复盘
 ## 项目列表
+%%本年经历的项目列表，从本年的日记中提取，并自动统计项目耗时占比%%
 ```periodic-para
 ProjectListByTime
 ```
 ## 本年收集
+%%本年收集的任务列表，从本年的日记中提取%%
 ```periodic-para
 TaskRecordListByTime
 ```
 
 ## 本年完成
+%%本年完成的任务列表，从所有的笔记中提取%%
 ```periodic-para
 TaskDoneListByTime
-```
+```
diff --git a/PeriodicNotes/2023/Daily/06/2023-06-01.md b/PeriodicNotes/2023/Daily/06/2023-06-01.md
@@ -4,6 +4,7 @@ tags: 节日/儿童节
 # 2023-06-01
 
 ## 项目列表
+%%项目的今日快照%%
 1. [[1. Projects/分享-2023 WOT 分享会/README|分享-2023 WOT 分享会]]
 
 8hr0
@@ -13,34 +14,35 @@ tags: 节日/儿童节
 - [ ] 11:15 调研下 WOT 是什么来头 📅 2023-06-02
 
 ## 习惯打卡
-- 不积跬步，无以至千里！
-	- [x] 起床一杯水 ✅ 2023-06-01
-	- [x] 早餐 ✅ 2023-06-01
-	-  喝水
-		- [x] +1 ✅ 2023-06-01
-		- [x] +1 ✅ 2023-06-01
-		- [x] +1 ✅ 2023-06-01
-		- [x] +1 ✅ 2023-06-01
-		- [x] +1 ✅ 2023-06-01
-		- [x] +1 ✅ 2023-06-01
-	- [x] 原味英语 ✅ 2023-06-01
-	- [x] 项目耗时统计 ✅ 2023-06-02
-	- 休息一下
-		- [x] +1 ✅ 2023-06-01
-		- [x] +1 ✅ 2023-06-01
-		- [ ] +1
-	- 站立式办公
-		- [x] +1 ✅ 2023-06-01
-		- [x] +1 ✅ 2023-06-01
-		- [x] +1 ✅ 2023-06-01
-		- [ ] +1
+- [x] 起床一杯水 ✅ 2023-06-01
+- [x] 早餐 ✅ 2023-06-01
+-  喝水
+	- [x] +1 ✅ 2023-06-01
+	- [x] +1 ✅ 2023-06-01
+	- [x] +1 ✅ 2023-06-01
+	- [x] +1 ✅ 2023-06-01
+	- [x] +1 ✅ 2023-06-01
+	- [x] +1 ✅ 2023-06-01
+- [x] 原味英语 ✅ 2023-06-01
+- [x] 项目耗时统计 ✅ 2023-06-02
+- 休息一下
+	- [x] +1 ✅ 2023-06-01
+	- [x] +1 ✅ 2023-06-01
+	- [ ] +1
+- 站立式办公
+	- [x] +1 ✅ 2023-06-01
+	- [x] +1 ✅ 2023-06-01
+	- [x] +1 ✅ 2023-06-01
+	- [ ] +1
 		
 ## 精力分配
+%%今日的项目列表，根据耗时情况，自动统计项目耗时占比%%
 ```periodic-para
 ProjectListByTime
 ```
 
 ## 今日完成
+%%今日完成的任务列表，从所有的笔记中提取%%
 ```periodic-para
 TaskDoneListByTime
 ```
diff --git a/PeriodicNotes/2023/Daily/06/2023-06-02.md b/PeriodicNotes/2023/Daily/06/2023-06-02.md
@@ -1,6 +1,7 @@
 # 2023-06-02
 
 ## 项目列表
+%%项目的今日快照%%
 1. [[1. Projects/分享-2023 WOT 分享会/README|分享-2023 WOT 分享会]] 0hr30
 
 8hr0
@@ -9,34 +10,35 @@
 - 18:20 收集了下 [#分享/WOT](app://obsidian.md/index.html#%E5%88%86%E4%BA%AB/WOT) 的[[往届主题]]，越往前越没有前端什么事往届主题
 
 ## 习惯打卡
-- 不积跬步，无以至千里！
-	- [x] 起床一杯水 ✅ 2023-06-02
-	- [x] 早餐 ✅ 2023-06-02
-	-  喝水
-		- [x] +1 ✅ 2023-06-02
-		- [x] +1 ✅ 2023-06-02
-		- [x] +1 ✅ 2023-06-02
-		- [ ] +1
-		- [ ] +1
-		- [ ] +1
-	- [x] 原味英语 ✅ 2023-06-02
-	- 休息一下
-		- [x] +1 ✅ 2023-06-02
-		- [ ] +1
-		- [ ] +1
-	- 站立式办公
-		- [x] +1 ✅ 2023-06-02
-		- [x] +1 ✅ 2023-06-02
-		- [ ] +1
-		- [ ] +1
-	- [x] 项目耗时统计 ✅ 2023-06-03
+- [x] 起床一杯水 ✅ 2023-06-02
+- [x] 早餐 ✅ 2023-06-02
+-  喝水
+	- [x] +1 ✅ 2023-06-02
+	- [x] +1 ✅ 2023-06-02
+	- [x] +1 ✅ 2023-06-02
+	- [ ] +1
+	- [ ] +1
+	- [ ] +1
+- [x] 原味英语 ✅ 2023-06-02
+- 休息一下
+	- [x] +1 ✅ 2023-06-02
+	- [ ] +1
+	- [ ] +1
+- 站立式办公
+	- [x] +1 ✅ 2023-06-02
+	- [x] +1 ✅ 2023-06-02
+	- [ ] +1
+	- [ ] +1
+- [x] 项目耗时统计 ✅ 2023-06-03
 
 ## 精力分配
+%%今日的项目列表，根据耗时情况，自动统计项目耗时占比%%
 ```periodic-para
 ProjectListByTime
 ```
 
 ## 今日完成
+%%今日完成的任务列表，从所有的笔记中提取%%
 ```periodic-para
 TaskDoneListByTime
 ```
diff --git a/PeriodicNotes/2023/Daily/06/2023-06-03.md b/PeriodicNotes/2023/Daily/06/2023-06-03.md
@@ -1,6 +1,7 @@
 # 2023-06-03
 
 ## 项目列表
+%%项目的今日快照%%
 1. [[1. Projects/分享-2023 WOT 分享会/README|分享-2023 WOT 分享会]] 2hr21
 
 9hr30
@@ -9,25 +10,26 @@
 - 10:30 #同事/B 催我报名了，我说不知道分享内容，他表示就是 #同事/C 那一套，我说那我就有概念了 #分享/WOT 
 
 ## 习惯打卡
-- 不积跬步，无以至千里！
-	- [x] 起床一杯水 ✅ 2023-06-03
-	- [x] 早餐 ✅ 2023-06-03
-	-  喝水
-		- [x] +1 ✅ 2023-06-03
-		- [x] +1 ✅ 2023-06-03
-		- [ ] +1
-		- [ ] +1
-		- [ ] +1
-		- [ ] +1
-	- [ ] 原味英语
-	- [x] 记账 ✅ 2023-06-03
+- [x] 起床一杯水 ✅ 2023-06-03
+- [x] 早餐 ✅ 2023-06-03
+-  喝水
+	- [x] +1 ✅ 2023-06-03
+	- [x] +1 ✅ 2023-06-03
+	- [ ] +1
+	- [ ] +1
+	- [ ] +1
+	- [ ] +1
+- [ ] 原味英语
+- [x] 记账 ✅ 2023-06-03
 
 ## 精力分配
+%%今日的项目列表，根据耗时情况，自动统计项目耗时占比%%
 ```periodic-para
 ProjectListByTime
 ```
 
 ## 今日完成
+%%今日完成的任务列表，从所有的笔记中提取%%
 ```periodic-para
 TaskDoneListByTime
 ```
diff --git a/PeriodicNotes/2023/Daily/06/2023-06-04.md b/PeriodicNotes/2023/Daily/06/2023-06-04.md
@@ -1,6 +1,7 @@
-# 2023-06-04
+ 2023-06-04
 
 ## 项目列表
+%%项目的今日快照%%
 1. [[1. Projects/分享-2023 WOT 分享会/README|分享-2023 WOT 分享会]] 1hr0
 
 8hr30
@@ -9,25 +10,26 @@
 - 19:04 想了一个多小时，也没想出一个适合《字节跳动的前端工程化实践》的大纲，已经求助 #同事/A ，我表示是不是主题太大了 #分享/WOT
 
 ## 习惯打卡
-- 不积跬步，无以至千里！
-	- [x] 起床一杯水 ✅ 2023-06-04
-	- [x] 早餐 ✅ 2023-06-04
-	-  喝水
-		- [x] +1 ✅ 2023-06-04
-		- [x] +1 ✅ 2023-06-04
-		- [x] +1 ✅ 2023-06-04
-		- [x] +1 ✅ 2023-06-04
-		- [x] +1 ✅ 2023-06-04
-		- [x] +1 ✅ 2023-06-04
-	- [x] 原味英语 ✅ 2023-06-04
-	- [ ] 记账 
+- [x] 起床一杯水 ✅ 2023-06-04
+- [x] 早餐 ✅ 2023-06-04
+-  喝水
+	- [x] +1 ✅ 2023-06-04
+	- [x] +1 ✅ 2023-06-04
+	- [x] +1 ✅ 2023-06-04
+	- [x] +1 ✅ 2023-06-04
+	- [x] +1 ✅ 2023-06-04
+	- [x] +1 ✅ 2023-06-04
+- [x] 原味英语 ✅ 2023-06-04
+- [ ] 记账 
 
 ## 精力分配
+%%今日的项目列表，根据耗时情况，自动统计项目耗时占比%%
 ```periodic-para
 ProjectListByTime
 ```
 
 ## 今日完成
+%%今日完成的任务列表，从所有的笔记中提取%%
 ```periodic-para
 TaskDoneListByTime
 ```