Blogging Memorandum
My "style guide" to bilingual writing.
TLDR - This is a “style guide” that I summarise and refer to when writing technical documents and blogs. If you are interested this document, you can get started from About This Guide.
摘要 - 本文是我在技术写作或写博客时总结并参考的”写作风格指南”。如果您对本文感兴趣，可以从文章介绍章节开始阅读。
ABOUT THIS GUIDE | 文章介绍
This “style guide” is my guidelines aiming at writing 3C articles. Contents are indexed (in alphabetical order) and categorised into the following sections:
本文意在提供如何写出3C的技术文章的指导规则。文章的内容将以类似词典的结构(首字母排序)被划分为以下章节:
- Principle | 写作原则: Semantic guidelines at the macro level | 宏观的语法指南.
- Lexicon | 词法: Lexical guidelines | 词法指南.
- Syntax | 句法: Syntactic guidelines | 句法指南.
By default, all contents will be served in equal English and Chinese, but depending on their core concepts, some sub-sections may have additional English or Chinese explanations.
本文所有内容默认提供中英对等译文，但一些子章节根据其核心概念可能会提供额外的单语解释。
All contents will be marked with either my “subjective” opinions or served with their “reference” origins, any feedback or suggestions are welcome!
所有内容都会标出是个人主观意见或是来源注释, 欢迎您提供意见与建议！
PROGRESS | 施工进度
- 3C: 补全表格, 总结.
- [abc]: 解释.
REFERENCE RESOURCE | 参考资源
Here are some editorial style guide resources that help me to build this style guide:
以下是帮助我构建该指南的参考资源:
- Microsoft Writing Style Guide | 微软 - 写作风格指南
- Google Developer Documentation Style Guide | Google - 开发者文档风格指南
- Apple Style Guide | Apple - 风格指南
- The Economist Style Guide (ISBN: 9781782833482)
PRINCIPLES | 写作原则
3C (Subjective)
3C stands for: Clear (Clarity) | 清晰, Concise (Conciseness) | 简洁, and Consistent (Consistency) | 一致:
| Writing aspects | Clarity | Conciseness | Consistency |
|---|---|---|---|
| Words | Write in [specific|unamibigous] words. | - | - |
| Sentences | Write in compact sentences. | - | - |
| [Voices|Tones] | - | - | - |
| Materials & References | Reference [specific|credible] materials. | - | - |
| Viewpoints | Illustrate [specific|explicit] viewpoints | - | - |
- Clarity implies …
- Conciseness implies …
- Consistency implies …
Extension: Seven C’s of effective communication (Effective Public Relations; S.Cutlip, A.Center)
- Completeness | 完整
- Conciseness | 简洁
- Consideration | 体贴
- Clarity | 清晰
- Concreteness | 具体
- Courtesy | 礼貌
- Correctness | 准确
LEXICON | 词法
Compound words (Ref.)
Compound words can be categorised into three forms:
复合词是由两个或以上的[单词|词干]组成的新单词, 有以下三种连接方式：
- Closed form | 闭合型: words are melded together (e.g. keyboard, breakfast).
- Hyphenated form | 连字符型: words are concatenated through hyphens (e.g. father-in-law, old-fashioned).
- Open form | 开放型: words are separated (e.g. post office).
When forming a compound word, use closed words (preferred) or hyphenated words as attributives, use open words as predicatives. For example:
当需要自定义组合复合词时，如果该词作定语，则推荐使用闭合型 (优先)或连字符型，如果该词作表语，则使用开放型。如下例：
Attributive: [Fullstack|Full-stack] development/developer
Predicative: Full stack programming/engineering
Plural indicators (s) (es) (Ref.)
Do not use (s), (es) to a singular noun to indicate that it can be singular or plural.
当需要表达某个名词可单数可复数时，不要使用(s)/(es)：
- Use plurals directly | 直接使用该名词的复数形式.
- To indicate something can be both singular and plural, use one or more or multiple.