技术文档学习笔记
本文主要记录了学习技术文档写作时需要注意的知识点。
内容书写
常见错误
常见错别字
“账号”误写为“帐号”
“登录”误写为“登陆”
常见拼写错误
此处的拼写错误可分为两类,一是单词字母拼写错误,二是单词大小写拼写错误。
参考文献:程序员写简历时的技术词汇拼写规范备忘录
在技术文档写作过程中,我们需要额外注意技术词汇的拼写。常见的技术词汇如下表所示:
编程语言
一般来说,编程语言的首字母大写。
数据库
数据库采用英文名称。
产品名称
以官网发布的名称为准。如,ZooKeeper, OceanBa.
原创
2021-12-17 14:34:34 ·
3948 阅读 ·
0 评论