欢迎你来到OceanBase社区交流、分享、传播你的知识与技能！
我们鼓励OceanBase开发者、贡献者、合作伙伴、用户，以及对OceanBase感兴趣的开源爱好者、数据库爱好者参与社区互动与活动、分享知识与心得。如果你喜欢用技术写作的方式与社区小伙伴交流经验，那么，阅读本文档将有助于你写出结构更完整、逻辑更清晰、表达更流畅、文字更规范的优质文章，让文章传播更广，提升你的个人影响力。
本文档包含以下几个部分：
- 我可以在哪里发文？
- 我可以分享什么内容？
- 我的内容怎么变得更优质？
- 社区不提倡什么内容？
一、我可以在哪里发文？
在OceanBase社区，「问答」区和「博客」区都提供了技术交流与写作的功能。
「问答」区没有任何写作门槛，如其名曰，你可以在这里提问任何关于数据库、关于OceanBase的问题，也可以回答别人提出的问题，或发帖分享你的OceanBase使用体验与技巧心得。在发帖时，建议你选择与题文匹配的分类与标签，有助于你的提问或分享被更多志趣相投的人看到，便于交流。
同时，你在社区的任何行为都会累计成长值，比如，创建问答或回复增加5个成长值，回复被采纳增加10个成长值。更多成长值累计规则与权益，可参考《新人必读》，成长值越高，享受的权益（如社区管理者、荣誉证书与勋章、贡献者费用、个人品牌包装及宣传）即越多。
当你的成长值达到500时，将为你开通「博客」区的写作权限。之所以会有这样的设定，是为了保证社区内容的健康与质量。当然，我们更不想因此功能限制你的热情与才华，如果你觉得自己“写得还可以”，欢迎你投稿（稿件发送至：openOceanBase@service.alibaba.com）或进入写作交流群（钉钉群号：29135003398）申请加入白名单，我们对优质内容始终敞开怀抱～
二、我可以分享什么内容？
在「专栏」页，你可以看到内容被分为九大类：设计原理、运维管理 、用户实践 、源码解读、应用开发 、社区新鲜事、行业洞察、产品动态、人物故事，这些分类除「社区新鲜事」「产品动态」外，都是你可以创作的方向。那么，分类下具体可以写哪些内容呢？
- 设计原理：架构解读、架构选型、原理解析等。
- 运维管理：性能调优、事务处理、故障排查、安装部署、备份恢复、监控等。
- 用户实践：降本增效、选型、迁移、集群管理、版本测评、SQL、高可用等。
- 源码解读：解读代码等。
- 应用开发：业务改造、二次开发、应用适配等。
- 行业洞察：技术观点、行业分析等。
- 人物故事：我与OceanBase的故事；参与OceanBase活动的体验；OBCA、OBCP、OBCE等考试&认证的心得；成长&踩坑经验；职业技能提升等。
三、我的内容怎么变得更优质？
什么是优质内容？
“优质”内容的定义是什么呢？怎样的内容才算得上优质内容？
对此，我们认为需要满足以下几点：
- 有明确的主题，且正文内容符合主题。
- 正文结构完整，标题层级清晰，且小标题能够清楚概括其章、节、段的内容。
- 内容包含经验传授、技巧分享、观点探讨、现象分析等可学习、可借鉴的干货。
- 行文逻辑清晰、流畅，段与段、句与句之间有衔接关系。
- 无明显语法、标点、别字等错误。
此外，如果你擅长把读者带入场景，用通俗易懂的语言讲述技术内容，能够将理论与案例结合且图文并茂、那么，阅读你的内容将会是一种享受，读者会在享受中获得知识。
怎么创作优质内容？
俗话说“万事开头难”，如果你想把自己的经验总结成文，却感觉不知从何写起或感觉不管怎么写都“不对，那你不妨尝试以下三步。
第一步：确定选题方向与内容结构
在开始敲下第一个字前，你可以先明确自己想写观点类、技术类、故事类还是其他类，然后制定一个文章框架。你可以参考下面三种框架模型。
- 提出问题-问题冲突-分析问题-解决问题。典型案例是是亮甲⼴告：得了灰指甲（提出问题）⼀个传染俩（问题冲突）问我怎么办（分析问题）马上⽤亮甲（解决问题）。再举个例子：在使用OceanBase的过程中发现了哪些问题（提出问题）；问题导致了什么后果或现象及引发了什么新的问题（问题冲突）；这个问题应该如何解决，解决思路是怎样的（分析问题）；具体怎么操作、操作过程中的难点如何逐一击破（解决问题）；最后总结文章知识点，将其升华为“套路”。
- 排列串珠。某组件的背景（作用、重要性等）介绍，该组件（串联线）有三个功能（串珠），A功能的作用与价值是什么，B功能与A功能的关系是什么，其作用与价值是什么，C功能与A/B功能的关系是什么，其作用与价值是什么。举个例子：OBProxy可以访问不同集群的不同租户的不同机器。这也是 OBProxy 可以实现集群路由、租户路由和租户内路由的原因，接下来我将围绕这三部分介绍OBProxy的路由功能。集群路由是……一个集群有多个租户，租户路由是……租户内路由是指在获取租户的机器列表后，选择合适的节点执行SQL，租户内路由……
- 英雄之旅。我有怎样的经历，我在这段经历中遇到了什么困难，怎么解决的，又遇到了什么困难，又是怎么解决的……
第二步：完成初稿的写作
确定文章框架后，你可以把该框架分成几个模块，按模块填内容。你可以有顺序地填空，也可以先填写自己最有灵感的部分。第二步的重点不在于将文章一次性写完整甚至完美，重要的是写下来，形成一篇素材稿。在此过程中，需要特别注意三点，这三点是决定读者阅读兴趣和阅读体验的关键。
- 文首引入。文首是吸引读者阅读兴趣的最佳位置，你可以介绍写作本文的背景或本文主讲的问题、能够解决读者的什么问题，通过一些共性问题（痛点）引起读者共鸣或通过介绍你将分享的经验勾起读者继续了解的兴趣，这里的关键在于建立起本文知识和读者自己的关系。
- 句段衔接。文章中的每段、每句之间都有潜藏的内在逻辑，你要做的是将内在逻辑也展示给读者，你可以问自己一些问题，比如，为什么要写这段内容，这段内容和上段的关系是什么，然后把答案写下来。有时候你可能认为“读者应该能看懂”“读者应该明白里面的关系”，请避免“应该”式的想法，把读者当作你的朋友，像讲故事或八卦那样，把故事“主角”之间的关系与叙事逻辑也写出来。
- 文末总结。避免路标式总结，即我先讲了什么，又讲了什么，最后讲了什么。总结的目的在于给读者精炼、有价值的信息，你可以强调文章的重点，可以强调解决方法，也可以延伸业务场景中容易踩的坑及怎么避免，还可以说说工作场景中、实践过程中有哪些难点，需要注意什么或者可以学习什么来克服这个难点。
第三步：检查并优化全文
完成初稿的写作后，你需要通读全文，查漏补缺，让文章内容变得完整、优质。那么，具体需要检查什么呢？
- 检查内容是否晦涩难懂。
- 检查是否只有观点和宏观⽅法论，缺少可落地的操作技巧。
- 检查是否列表式⾏⽂，没有衔接。
- 检查文字基础规范，即是否有语病、错别字、标点符号错用、英文单词大小写不规范等。
对于文字晦涩难懂和句段衔接缺失这两个问题，其实你要解决的是“不说大白话”和“前言不搭后语”对问题，相信你可以做到。此处针对观点和落地方法给出具体建议，文字基础规范将作为单独的一节供你参考。
首先，如果你想写行业解析、趋势解读等观点类的文章，如何确保文章有论有据呢，你可以多问自己为什么：
- 我为什么提出这个观点？和文章核心观点是否有出入？
- 我提出的观点是否有歧义，容易引发误解？
- 我的举例是否足以解释观点，还是自圆其说？
- 能否用一句话从发散论证中收拢，帮助读者更好地理解文章？
在自我问答的过程中，你会重新思考和梳理观点的表述正确性及论证的充足性，这会让你的内容更加饱满。
其次，很多人在写作时容易飘在空中，文章看似讲了很多知识，实则难以落地。举个例子，你将自己改写SQL的经验写下来分享到了社区，读者按照你的步骤实操后却遇到了新的问题。其实，他只从你的文章中读到了基本步骤却没能学到你在改写过程中获得的知识与思考。对于类似的情况，建议你在重读文章的过程中，检查有没有痛点、难点、坑点并完善它们，提升文章的参考价值。
文字基础规范
在文章内容完善后，建议你最后再检查一遍文字规范。技术文章中常见的规范问题如下。
1. 数字用法
（1）表示年代时数字的用法
前后统一用阿拉伯数字或统一用中文数字。
误：20世纪八十年代
正：二十世纪八十年代
正：20世纪80年代
误：20世纪八、九十年代
正：20世纪八九十年代
误：1970s（在正式出版物中一般用上述正确例子的表述）
（2）表示年份时的数字用法
表示确切年份时，用阿拉伯数字，如20年；表示范围年份时，用汉语数字，如二十余年了，二十多年前。
误：20余年/多年
正：二十余年/多年
（3）数值的增加和减少
数值的增加可用倍数和百分数表示，例：增加了2倍；增加了70%。
数值的减少只能用百分数或分数表示，例：降低了30%；减少了1/3。不能用“降低了3倍”“减少了2倍”
2. 的地得的用法
“的”前面加修饰词，后面跟名词，一般是形容后面的人事物怎么样。例如：优雅的老奶奶、奇形怪状的大树、有趣的环境。
“地”前面是形容词，后面跟动词，说明“地”后面的动作怎么样。例如，一次又一次地握手、迅速地包围、沙沙地直响、斩钉截铁地说。
“得”前面基本是表示动作的词，后面跟形容词，后面的形容词是补充说明前面的词怎么样。例如，红得发紫、惊讶得目瞪口呆、扫得真干净。
3. 关联词搭配
误：因为……因此……
误：由于……所以
误：不仅……竟然……
正：因为……所以……
正：由于……因此……
正：不仅……还/而且……
注意：不能套用，不能语义重复
4. 层级、项目符号的用法
层级保持一致，不可以出现层级搭配不当的现象。
误
一、
（一）
（二）
二、
1、
2、
首先、第二、第三
一个、另一个、第三
正
一级标题
二级标题
三级标题
首先、其次、再次、最后
第一、第二、第三
一、(一)、1等为标题层次，须为标题，没有则提炼，标题下须有内容（没有就加几句），不能没有内容。标题层无标点符号。
（1）、 1）、①、●（无序项目符）以下为接排层次，项目符后无标点，句末标点统一（可以用分号，但一般建议用句号）。
层级（1）后可以跳层级用①，但层级①后不能用1）、（1）、1. ……一般无序项目符的层级低于有序项目符。
5. 标点符号用法
（1）双引号、书名号用法
双引号、书名号之间不加标点
误：《编程之美》、《构建之法》、《智能之门》
正：《编程之美》《构建之法》《智能之门》
误：“人物”、“时间”、“地点”
正：“人物”“时间”“地点”
中文书名加书名号不斜体，英文书名和论文斜体，且不加书名号。
（2）冒号不能重用
误：
正：
6. 连接号的用法
（1）一字线“—”的用法
一字线主要用于2个及以上名词或时间的连接，表示走向、起止或递进关系。下述例子中，一字线都有至（到）的意思，用“至”字替换，不影响句子表达。
- 表示走向：
- 东北—西南方向
- 秦岭—淮北地区
- 表示起止：
- 天津—北京—河北
- 20世纪80—90年代
- 2000—2020年
- 1—5月
- 13—15日
- 下午14：00—16：00
- 35—45页
- 表示递进：
- 数据库经历了SQL—NoSQL—NewSQL三个发展阶段
- 图书的间接销售主要是出版社—图书批发商—零售书店—读者这种形式
（2）半字线“-”的用法
半字线主要用于连接阿拉伯数字、字母等，或者用于连接一些相关词语，半字线没有字面意义，只是表示前后两者的间隔关系。
- 用于阿拉伯数字、字母之间，表示型号：SDY-1A
- 用于图、表编号的中间：图3-5、表2-7
- 用于连接一些相关词语，组成复合词组：总产量-相关产量-平均产量曲线图
- 用于连接年、月、日，表示日期：2021-1-1
（3）波纹线的用法
波纹线只有一种用法，就是用于两个数值之间，表示范围。如：1100GB；8%9%；100万200万；1℃9℃。
（4）长横线的用法
长横线的用法和破折号基本一致，主要用于解释。
- 当用于标题时，表示主副标题，如：从分布式到云原生——数据库发展主导力量解读
- 当用于多事项的列举分承，如：书稿的三审是指：
- ——初审。由具有编辑职称或具备一定条件的助理编辑人员担任。
- ——复审。由具有正、副编审职称的编辑室主任一级的人员担任。
- ——终审。由具有正、副编审职称的社长、总编辑担任。
7. 科技名词/名称
- 外国人名可使用原文，给出姓的全称和名的缩写。如果需要汉译，应按外文译音表翻译，并在文中第一次出现时注出原文，不可随意进行音译。
- 国内地名以地图出版社最新出版的地图册为准，文中涉及的所有地图都需送审，涉及古地名时应加注现代地名，如“长安（今西安）”。
- 外国地名和国名以地图出版社最新出版的中外文对照地图册为准。
- 一般的机关、团体、学校、研究机构和企业等名称，在文中第一次出现时应写明全称，以下方可用简称。外文的机构名称第一次出现时应加注原文。
- 国家法律、法规、国家标准等，第一次应写全称，以后方可用简称。
- 文中第一次出现的机具仪器设备等名称，一般应写出铭牌上的全称。
- 全文/统一名词术语、人名、地名、机构名等前后必须统一。
- 需要注意以下词（括号内为不正确的用法）：
- 计算机（电脑） 默认（缺省） 复制（拷贝） 通信（通讯） 连接（联结）
- 港澳台地区（港澳台） ASCII（ascii） VB（Vb） 网际协议（网际互连协议）
- 以下词语中括号内为推荐用法
- 应用普及（应用广泛） 一公里（1km） 10公斤（10kg）
- M字节（MB） bit/bits（b） byte/bytes（B）
8. 易错字
（1）做vs作
“作”多用于一般性的活动，且动作性不强，比较抽象，其用法与“进行”相当。例如：作安排、作采访、作承诺、作冲刺、作沟通、作构思、作观察、作扩展、作检讨、作交代、作交流、作思考、作案、作保、作弊、作恶、作风、作梗、作价、作数、作为、作伪、作用、作证。
“做”多用于具体性的事务或职业性、专业性的工作。例如：做工、做课(举行示范性或实验性的公开课)、做活儿、做题、做药、做账、做保险。做饭、做鬼脸、做家务、做手势、做姿势、做游戏、做针线。
误：它们不遵循关系数据库模型，也不使用SQL做为查询语言。
正：它们不遵循关系数据库模型，也不使用SQL作为查询语言。
误：这个转换的方法叫做“嵌入”（embedding），转换的过程叫做“图的表示”。
正：这个转换的方法叫作“嵌入”（embedding），转换的过程叫作“图的表示”。
（2）度过vs渡过
渡过指的是由这一空间到那一空间，如渡过黄河、渡过难关等；度过指的是由这一时间到那一时间，如度过夏天、度过一天、度日如年等。需要注意“普度众生”的“度”作度化与超度解，故不宜用“渡”。
误：度过当前阶段
正：渡过当前阶段
误：普渡众生
正：普度众生
（3）其它vs其他
书面不用“其它”。“其他”同“其它”，不同的是“其它”只能用于事物，而“其他”可用于人物、事物。当我们不确定用法时，就用“其他”，不用“其它”。
（4）其他的易错字
正：密钥
误：秘钥
正：抑或
误：亦或者
9. 技术名词常见错误
错误->正确
APP->App
mysql->MySQL
elasticsearch/ElasticSearch->Elasticsearch
java/JAVA->Java
web->Web
restful/Restful/RestFul->RESTful
sqlserver/SQLserver->SQLServer
mongoDb->MongoDB
hive->Hive
kafka->Kafka
flink->Flink
etcd/Etcd->ETCD
linux/LINUX->Linux
ngnix/NGINX->Ngnix
http/Http->HTT
10. 图表
以下为图书出版要求，在博文中不强制要求。
- 通常先见文字叙述，后见插图（表），凡是文中出现的图（表），均应在文字叙述中提及，并明确图号（表号），不能使用“如上（下）图所示”，应该使用“（见图/表x）”。图（表）随文排，图（表）文呼应，图（表）不跨节。
- 所有表的引用，格式统一为“，见表X”。
- 所有图的引用，位于句首，引用格式为“如图X，”，“图X是……”；位于句末且无括号，引用格式为“，如图X所示。”；所有带括号的，引用格式为“（见图X）”;位于句中且无括号，引用格式为“……图X是……”。
- 函数曲线图的要求
- 表的栏目中不得出现无文字的空白栏目。相邻栏内数字相同时，应重复书写，不能用“同上”字样。
11. 计量单位
- 单位要标准化，宜将米、厘米、千克（公斤）……统一为m 、cm 、kg ……。
- 凡是国家标准中已有的计量单位都要尽量使用标准规定的单位符号，不用或少用单位的中文名称。
- K 、G 、M等词头不能单独用作单位符号，如60GB，不能写作60G。
- B/s和b/s的含义不同，前一个表示“字节每秒”，后一个表示“位每秒”或“比特每秒”，不能混用。可以分别写作Bps与bps，但全文需统一。
- 注意k与K的区别。K是国际单位的词头，表示1000；但在计算机中表示字节或位时，K用来表示1024。
12. 其他
（1）地域词句
正确：31个省、自治区、直辖市
错误：31个省、市（区）
（2）“及”“以及”的用法
“及”表并列，如“A、B及C”。
“以及”表并列，格式为“，以及……”。例如，“如何管理这些服务的连接关系，以及如何保持通信通道的无故障、安全、高可用和健壮，就成了非常大的挑战。”
（3）“涉及”“加入”“提及”等词语后面不加“到”
错误示范：这次的安全培训，涉及到三个部门。
（4）“如”“例如”“比如”的用法
“比如”常用在口语化表述中，可搭配语气词，如“比如说”等。“比如”后面列举的内容，既可以是事实，也可以是不存在的。当列举的内容为字、词组，或只有一个较短的例子时，用“如”，格式为“，如A、B、C。”“如……。”
“例如”是书面语，不可搭配语气词，后面列举的内容必须有事实依据。当列举的内容为多个长句（句子成分完整），且与要论述的内容相同时，用“例如”，格式为“。例如，……。”
（5）“等”“等等”的用法
等：表示省略未被说明的内容，已被完全列举的内容后面不能用等。例如，“本文从工业大数据架构、数据如何写入、存储、查询等方面带来深度解析。”应改为“本文从工业4.0、工业大数据架构，以及数据的写入、存储、查询这几个方面带来深度解析。”
等等：表示省略，与“等”的意思相同。但使用格式不同，此用法的格式为“，等等。”。
（6）“所谓”的用法
正：所谓xxx，是……
误：所谓的xxx是……
（7）容易冗余/语义重复的词
正：其中
误：这其中
正：并非
误：并非是
四、社区不提倡什么内容？
为了保证社区内容的健康和质量，我们在发布文章时设置了过滤机制，系统会自动排查违规类、广告类、政治敏感类等文章。因此，建议你避免发布以下内容。
- 涉及黄赌毒与政治敏感话题的内容
- 在其他平台抄袭的他人内容
- 诋毁、吐槽等负面内容
- 品牌、活动、视频、招聘等推广内容
最后，预祝你写作顺利，如需社区编辑帮忙优化文章或与更多热爱写作的同学交流学习，欢迎你进入写作交流群（钉钉群号：29135003398）。
