内容书写 常见错误 常见错别字本文主要记录了学习技术文档写作时需要注意的知识点。
- “账号”误写为“帐号”
- “登录”误写为“登陆”
此处的拼写错误可分为两类，一是单词字母拼写错误，二是单词大小写拼写错误。
参考文献：程序员写简历时的技术词汇拼写规范备忘录
在技术文档写作过程中，我们需要额外注意技术词汇的拼写。常见的技术词汇如下表所示：
- 编程语言
一般来说，编程语言的首字母大写。 - 数据库
数据库采用英文名称。 - 产品名称
以官网发布的名称为准。如，ZooKeeper, Oceanbase, MaxCompute。
| 规范书写 | 不合适拼写举例 | 备注 |
|---|---|---|
| RESTful | Restful、RestFul | REST=Representational State Transfer |
| Spring | spring | |
| Spring MVC | SpringMVC、Springmvc | Spring MVC中间有空格！ |
| Spring Boot | Springboot、SpringBoot | Spring Boot中间有空格！ |
| Spring Cloud | Springcloud、SpringCloud | Spring Cloud中间有空格！ |
| OOP | oop | Object Oriented Programming |
| PO | po | Persistant Object |
| POJO | pojo | Plain Ordinary Java Object |
| Web | web、WEB | |
| Java | JAVA、java | |
| JVM | jvm、Jvm | Java Virtual Machine |
| GC | gc | Garbage Collection |
| Java EE | java ee | Enterprise Edition |
| Java SE | java se | Standard Edition |
| Golang | golang | |
| Python | python | |
| Linux | linux | |
| Runtime | runtime | |
| DNS | dns | Domain Name System 域名系统 |
| DI | di | Dependency Injection 依赖注入 |
| DB | db | Database |
| ACID | acid | Atomicity+Consistency+Isolation+Durability |
| DDL | ddl | Data Definition Language 数据定义语言 |
| DML | dml | Data Manipulation Language 数据操纵语言 |
| MySQL | mysql | |
| SQLite | sqlite | |
| SQLServer | sqlserver、SQLserver | |
| NoSQL | nosql、NOSQL | NoSQL=Not only SQL |
| JDBC | Jdbc、jdbc | Java Database Connectivity |
| ORM | orm | Object/Relational Mapping 对象/关系映射 |
| JPA | Jpa | Java Persistence API |
| MyBatis | mybatis、Mybatis | |
| MyBatis-Plus | MyBatisPlus myBatis-plus | |
| Maven | maven、MAVEN | |
| Redis | redis | |
| MongoDB | mongoDB | |
| MQ | mq | Message Queue |
| RabbitMQ | rabbitMQ | |
| RocketMQ | rocketMQ | |
| ActiveMQ | activeMQ | |
| Netty | netty | |
| gRPC | grpc | |
| Dubbo | dubbo | |
| JSON | Json | Javascript Object Notation |
| JWT | jwt | JSON Web Token |
| XML | Xml | Extensible Markup Language |
| API | Api | Application Programming Interface |
| Jenkins | jk、jenkins | |
| Docker | docker | |
| UML | Uml | Unified Modeling Language |
| SOA | Soa | Service Oriented Architecture |
| MVC | Mvc | Model–View–Controller |
| MVVM | Mvvm | Model-View-ViewModel |
| MVP | Mvp | Model-View-Presenter |
| 持续更新中... | - | - |
前端开发相关
| 规范书写 | 不合适拼写举例 | 备注 |
|---|---|---|
| HTTP | Http、http | Hyper Text Transfer Protocol |
| HTTPS | https、Https | Hyper Text Transfer Protocol over SecureSocket Layer |
| DOM | dom | document Object Model |
| Javascript | javascript、Javascript、js、JS | |
| CSS | Css、css | Cascading Style Sheets |
| HTML | Html、html | Hyper Text Markup Language |
| jQuery | jquery、JQuery | |
| Bootstrap | bootstrap | |
| Node.js | node、NodeJS、nodejs | |
| Vue.js | vue、VUE、vue.js | |
| React | react | |
| Angular | angular | |
| SPA | spa | Single Page Application |
| MPA | mpa | Mutiple Page Application |
| 持续更新中... | - | - |
客户端开发相关
| 规范书写 | 不合适拼写举例 | 备注 |
|---|---|---|
| App | APP、app | |
| Objective-C | OC、oc | |
| Xcode | xcode、XCODE、XCode | |
| iPhone | iphone | |
| iOS | ios、IOS | |
| Android | android | |
| RxJava | RXJava、rxjava | |
| Android Studio | as、android studio | |
| 持续更新中... | - | - |
大数据/云计算相关
| 规范书写 | 不合适拼写举例 | 备注 | |
|---|---|---|---|
| Hadoop | hadoop | ||
| HDFS | hdfs、Hdfs | Hadoop Distributed File System | |
| MapReduce | mapreduce、mr | ||
| Hbase | hbase、Hbase | ||
| Hive | hive | ||
| Yarn | yarn | ||
| Kafka | kafka | ||
| ZooKeeper | zookeeper、zk | ||
| Storm | storm | ||
| Flink | flink | ||
| Elasticsearch | elasticsearch、ElasticSearch、es | ||
| Logstash | logstash | ||
| Kibana | kibana | ||
| Kubernetes | k8s | 官方简写为K8s | |
| 持续更新中... | - | - |
| 规范书写 | 不合适拼写举例 | 备注 |
|---|---|---|
| SVN | svn | Subversion |
| Git | GIT、git | |
| GitHub | github、Github | |
| Intellij IDEA | intellij idea、idea | |
| Eclipse | eclipse | |
| MyEclipse | myeclipse | |
| Postman | postman | |
| 持续更新中... | - | - |
- 路径与文件名应使用行内代码，如/etc/passwd
- 图片需要添加 黑色边框
- 图片应与 第一列文字 对齐
- 图片中的敏感信息(如IP地址、用户名)需使用 像素化 做脱敏处理
