pop6 's Notes
1
Toggle navigation
pop6 's Notes
主页
About Me
归档
标签
[模板] 技术文档
2021-08-04 15:34:30
340
0
0
pop6
> 参考： > * [中文技术文档写作风格指南](https://zh-style-guide.readthedocs.io/zh_CN/latest/%E5%85%B3%E4%BA%8E%E6%9C%AC%E6%8C%87%E5%8D%97.html) * [中文技术文档的写作规范](https://www.ruanyifeng.com/blog/2016/10/document_style_guide.html) # 技术文档用词说明 技术文档中，我们经常表达一些要求，例如：代码中`禁止`行尾注释；建表`必须`添加自增ID。[rfc2119](https://www.ietf.org/rfc/rfc2119.txt) 定义了一些**表示要求的严格程度**的动词，如下图： 关键词 | 中文关键词| 释义 --|--|-- MUST/REQUIRED/SHALL| 强制/`必须`/务必/只能 | 强制性规则，表示绝对要求这样做 MUST NOT/SHALL NOT| `禁止`/不能/不要 | 强制性规则，表示绝对禁止这样做 SHOULD/RECOMMENDED | 应/`应当`/应该/建议/推荐 | 非强制性规则，表示一般情况下应该这样做，但在知悉全部后果的前提下，可以选择不这样做 SHOULD NOT/NOT RECOMMENDED| 不应当/`不应该`/不建议/不推荐| 非强制性规则，表示一般情况下不应该这样做，但在知悉全部后果的前提下，可以选择这样做 MAY/OPTIONAL |`可以`/可选| 非强制性规则，表示这个要求是可选的，可以这样做，也可以不这样做 # 更多规范 见**参考**部分。 # ---- Template Start ---- > 个人简单的技术文档模板。 # 一.简介 # 二.快速上手 ## 1.环境准备 ## 2.安装 ## 3.配置 ## 4.使用 # 三.基础概念 # 四.进阶知识 # 五.实现原理（可选） # 六.开发实践（可选） # 七.常见问题 # ---- Template End ----
上一篇:
下一篇:
OLAP笔记
0
赞
340 人读过
新浪微博
微信
腾讯微博
QQ空间
人人网
提交评论
立即登录
, 发表评论.
没有帐号?
立即注册
0
条评论
More...
文档导航
pop6
没有帐号? 立即注册