Skip to content

Commit d4bdd93

Browse files
committed
chore(doc): add docs
1 parent 2feb9c9 commit d4bdd93

File tree

4 files changed

+123
-89
lines changed

4 files changed

+123
-89
lines changed

doc/TODO.org

Lines changed: 0 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -314,96 +314,19 @@ finish TODO
314314

315315

316316

317-
* TODO 重命名“类图”为“领域模型”
318317

319-
* TODO 重命名“客户”为“用户”
320-
321-
TODO handle 依赖隔离模式
322-
323-
* TODO 抽象代码都用Typescript
324-
325-
* TODO 简化抽象代码
326-
327-
* TODO 简化文中的示例代码
328-
329-
* TODO 简化UML
330-
331-
332-
* TODO unify story
333-
334-
一家公司,开发项目
335-
336-
引入角色:
337-
开发者
338-
小李
339-
小陈
340-
经理
341-
老刘
342-
343-
* TODO unify 给出UML 的描述
344-
345-
先说“总体上来看,xxx”
346-
然后再介绍每个部分的具体模块
347-
348-
349-
350-
使用总-分-总?套路,最后一个总可选
351-
352-
353-
* TODO 在给出代码->结束一段代码的分析时,给出承上启下语句:总结上段代码,引出下段代码
354-
355-
356-
# * TODO 统一给出代码:首先,我们看下xxx;然后,我们看下xxx;。。。
357-
* TODO 给出代码
358-
359-
refer to 多线程模式:
360-
使用总-分结构:
361-
总:
362-
首先,我们看下xxx代码;。。。
363-
分:
364-
### [步骤1]
365-
首先,我们看下xxx代码;。。。
366-
### [步骤2]
367-
首先,我们看下xxx代码;。。。
368-
369-
370-
371-
* TODO “运行代码”要说明运行Client代码
372-
373-
* TODO 统一“概述解决方案”,与之前提出的问题对应
374-
375-
通过模板:
376-
通过下面的改进来xxx:
377-
xxx
378-
379-
380-
* TODO give where has code, uml and how to run code and run result for each example
381-
382-
TODO give how to run rescript code(pipeline pattern should mention it!)
383318

384319

385320

386321
# * TODO 修改接口为type,《type》
387322

388323

389324

390-
* TODO package.json supply dependencies, devDependencies
391-
e.g. most, commonlib
392-
393-
394-
* TODO 移除"import"相关代码
395-
396325

397326

398327
* TODO 重写“依赖隔离模式”:统一格式; update 使用场景:推广; rename IRenderEngine to RenderEngine; replace Onion architecture image
399328

400329

401-
* TODO 加入过渡语
402-
403-
书还需要更完备些,比如介绍一个东西,经典逻辑三问,我是谁,我从哪里来,到哪里去
404-
405-
而且前后需要承上启下,背景介绍清楚些,写作从容些
406-
407330

408331

409332
* TODO 前言
@@ -425,17 +348,5 @@ e.g. most, commonlib
425348

426349

427350

428-
* TODO 改错
429-
430-
ECS:heros ->heroes
431-
432-
433-
* TODO 整理每个package代码,给出运行代码的script;并在README中说明如何运行,怎样运行
434-
435351

436352
* TODO 书给出网站(包含代码)二维码
437-
438-
439-
** TODO 代码示例
440-
441-
https://github.com/nivance/DPModel

doc/第三轮.org

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
2+
* TODO 给出过渡语
3+
4+
** TODO unify story
5+
6+
一家公司,开发项目
7+
8+
引入角色:
9+
开发者
10+
小李
11+
小陈
12+
经理
13+
老刘
14+
15+
** TODO unify 给出UML 的描述
16+
17+
先说“总体上来看,xxx”
18+
然后再介绍每个部分的具体模块
19+
20+
21+
22+
使用总-分-总?套路,最后一个总可选
23+
24+
25+
** TODO 在给出代码->结束一段代码的分析时,给出承上启下语句:总结上段代码,引出下段代码
26+
27+
28+
# ** TODO 统一给出代码:首先,我们看下xxx;然后,我们看下xxx;。。。
29+
** TODO 给出代码
30+
31+
refer to 多线程模式:
32+
使用总-分结构:
33+
总:
34+
首先,我们看下xxx代码;。。。
35+
分:
36+
### [步骤1]
37+
首先,我们看下xxx代码;。。。
38+
### [步骤2]
39+
首先,我们看下xxx代码;。。。
40+
41+
42+
43+
** TODO “运行代码”要说明运行Client代码
44+
45+
** TODO 统一“概述解决方案”,与之前提出的问题对应
46+
47+
通过模板:
48+
通过下面的改进来xxx:
49+
xxx
50+
51+
** TODO 加入过渡语
52+
53+
书还需要更完备些,比如介绍一个东西,经典逻辑三问,我是谁,我从哪里来,到哪里去
54+
55+
而且前后需要承上启下,背景介绍清楚些,写作从容些
56+
57+
58+
* TODO 修改代码
59+
60+
** TODO 移除"import"相关代码
61+
62+
63+
** TODO 抽象代码都用Typescript
64+
65+
** TODO 简化抽象代码
66+
67+
** TODO 简化文中的示例代码
68+
69+
70+
71+
** TODO package.json supply dependencies, devDependencies?
72+
e.g. most, commonlib
73+
74+
75+
76+
* TODO 修改UML
77+
78+
** TODO 简化UML
79+
80+
* TODO 改错
81+
82+
** TODO 重命名“类图”为“领域模型”
83+
84+
** TODO 重命名“客户”为“用户”
85+
86+
TODO handle 依赖隔离模式
87+
88+
89+
** TODO 改错
90+
91+
ECS:heros ->heroes

doc/第五轮.org

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
* TODO 交稿给编辑老师,改错
2+
3+
4+
5+
6+
* TODO 加入前言等补充章节
7+
8+
9+
* TODO 上线书的网站
10+
11+
12+
** TODO 书给出网站(包含代码)二维码
13+
14+

doc/第四轮.org

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
* TODO 修改结构,改成正式成书的结构
2+
3+
4+
* TODO 更新代码库,给出索引、how to run
5+
6+
** TODO give where has code, uml and how to run code and run result for each example
7+
8+
TODO give how to run rescript code(pipeline pattern should mention it!)
9+
10+
11+
12+
** TODO 整理每个package代码,给出运行代码的script;并在README中说明如何运行,怎样运行
13+
14+
15+
16+
** TODO 代码示例
17+
18+
https://github.com/nivance/DPModel

0 commit comments

Comments
 (0)