41 lines
1.7 KiB
Markdown
41 lines
1.7 KiB
Markdown
# 此方 Bot 的文档系统
|
|
|
|
此方 Bot 使用类 Linux 的 `man` 指令来管理文档。文档一般建议使用纯文本书写，带有相对良好的格式。
|
|
|
|
## 文件夹摆放规则
|
|
|
|
`docs` 目录下，有若干文档可以拿来阅读和输出。每个子文件夹里，文档文件使用名字不含空格的 txt 文件书写，其他后缀名的文件将会被忽略。所以，如果你希望有些文件只在代码库中可阅读，你可以使用 `.md` 格式。
|
|
|
|
### 1 - user
|
|
|
|
`docs/user` 目录下的文档是直接会给用户进行检索的文档，在直接使用 `man` 指令时，会搜索该文件夹的全部文件，以知晓所有有文档的指令。
|
|
|
|
### 3 - lib
|
|
|
|
`docs/lib` 目录下的文档主要给该项目的维护者进行阅读和使用，讲述的是本项目内置的一些函数的功能讲解（一般以便利为主要目的）以及一些项目安排上的要求。一般不会列举，除非用户指定要求列举该范围。
|
|
|
|
### 7 - concepts
|
|
|
|
`docs/concepts` 用来摆放任何的概念。任何的。一般不会列举，除非用户指定要求列举该范围。
|
|
|
|
### 8 - sys
|
|
|
|
`docs/sys` 用于摆放仅 MTTU 群可以使用的文档集合。在 MTTU 群内，该目录下的文档也会被索引，否则文档将不可阅读。
|
|
|
|
## 书写规范
|
|
|
|
无特殊要求，因为当用户进行 `man` 的时候，会将文档内的内容原封不动地展示出来。但是，你仍然可以模仿 Linux 下的 `man` 指令的格式进行书写。
|
|
|
|
```
|
|
指令介绍
|
|
man - 用于展示此方 BOT 使用手册的指令
|
|
|
|
格式
|
|
man [文档类型] <指令>
|
|
|
|
示例
|
|
`man` 查看所有有文档的指令清单
|
|
`man 喵` 查看指令「喵」的使用说明
|
|
……
|
|
```
|