博客格式规范

Posted on:  at 

记录下我以后博客的书写格式,以免忘记以及慢慢完善。
部分内容参考自阮一峰-中文技术文档的写作规范

段落

层次

文章最多只能有三级目录,第一级是 # 大小的,第二级是 ## 大小的,第三级是 ###大小。

若三级目录下还有分节需要,尽量使用项目列表:

# 标题1

## 标题2

### 标题3

- 标题3.1

  正文

- 标题3.2

  正文

***

段落间格式

一级段落之间使用分割线进行区分 ***


中英文文本的处理

全角中文和半角英文之前,应有一个半格空格分隔。

错误:本文介绍Window系统。
正确:本文介绍 Window 系统。

全角中文字符与半角阿拉伯数字之间,有没有半角空格都可,但必须保证风格统一,不能两种风格混杂。

半角的百分号,视同阿拉伯数字。

错误:2011年5月15日,我订购了 5 台笔记本电脑与 10 台平板电脑。
正确:2011 年 5 月 15 日,我订购了 5 台笔记本电脑与 10 台平板电脑。

英文单位若不翻译,单位前的阿拉伯数字与单位间不留空格。

错误:一部容量为 16 GB 的智能手机
正确:一部容量为 16GB 的智能手机

半角英文字符和半角阿拉伯数字,与全角标点符号之间不留空格。

错误:他的电脑是 MacBook Air 。
正确:他的电脑是 MacBook Air。

语言风格

尽量不使用被动语态,改为使用主动语态。

错误:假如此软件尚未被安装,
正确:假如尚未安装这个软件,

不使用非正式的语言风格。

错误:Lady Gaga 的演唱会真是酷毙了,从没看过这么给力的表演!!!
正确:无法参加本次活动,我深感遗憾。

用对“的”、“地”、“得”。

她露出了开心的笑容。
(形容词+的+名词)

她开心地笑了。
(副词+地+动词)

她笑得很开心。
(动词+得+副词)

使用代词时(比如“其”、“该”、“此”、“这”等词),必须明确指代的内容,保证只有一个含义。

错误:从管理系统可以监视中继系统和受其直接控制的分配系统。
正确:从管理系统可以监视两个系统:中继系统和受中继系统直接控制的分配系统。

名词前不要使用过多的形容词。

错误:此设备的使用必须在接受过本公司举办的正式的设备培训的技师的指导下进行。
正确:此设备必须在技师的指导下使用,且指导技师必须接受过由本公司举办的正式设备培训。

单个句子的长度尽量保持在 20 个字以内;20 ~ 29 个字的句子,可以接受;30 ~ 39 个字的句子,语义必须明确,才能接受;多于 40 个字的句子,在任何情况下都不能接受。

错误:本产品适用于从由一台服务器进行动作控制的单一节点结构到由多台服务器进行动作控制的并行处理程序结构等多种体系结构。
正确:本产品适用于多种体系结构。无论是由一台服务器(单一节点结构),还是由多台服务器(并行处理结构)进行动作控制,均可以使用本产品。

同样一个意思,尽量使用肯定句表达,不使用否定句表达。

错误:请确认没有接通装置的电源。
正确:请确认装置的电源已关闭。

避免使用双重否定句。

错误:没有删除权限的用户,不能删除此文件。
正确:用户必须拥有删除权限,才能删除此文件。


文章模板

翻译类文章

标题格式

[译] 我希望在 25 岁时就知道的 10 条理财经验

正文格式

  1. 标明来源

原文地址:https://hackernoon.com/10-money-lessons-i-wish-i-knew-when-i-was-25
原文作者:Paul Knulst
原文发布于:2023 年 08 月 05 日