1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
This document defines the rules for creating and maintaining specification files.
Important formatting rules
- -
A single file providing a high-level summary of the entire system.
A specification file for each individual module.
- -
Make sure that the `module_name` is the top most common just after `src/`
For example `src/module_01/sub_mod/some_file.rs` the spec module name will be `dev/spec/spec-module_01.md`
(module_name is lowercase)
Each `spec-module-path-name.md` file must include the following sections.
<module_spec_template>
A clear description of the module’s purpose and responsibilities.
A description of the APIs exposed by the module.
- -
A breakdown of the module’s internal components.
- -
Key design considerations of this module and of its key parts.
</module_spec_template>