よく知られているように、統一されたスタイルと文法の整形は、記事をより読みやすくし、コミュニケーションのコストを下げることができます。
記事の構造#
技術記事を作成する際には、以下の構造を参考にすることができます：
# 記事のタイトル
本文の内容を一、二文で紹介します。
## 効果
デモの使用方法を大まかに紹介し、効果を示します。
## 原理
原理を段階的に紹介してください。
## 結論
簡単なまとめを行います。
## 参考文献と謝辞
- [参考文献1](参考文献1のリンク)
- [参考文献2](参考文献2のリンク)
整形の規範#
段落#
- Markdown の文法を使用する場合、最初の行はインデントを行いません。
- 段落と段落の間には空行を入れる必要があります。
スペースを追加する必要がある場面#
- 中英文や数字の間：
間違い：
Qt生成器は一个针对C++的跨平台IDE
正しい：Qt 生成器は一个针对 C++ 的跨平台 IDE - 数字と単位の間：（ただし、数字とパーセント記号の間にはスペースを追加しないでください）
間違い：
其频率为 72MHz，占空比为 50 %。
正しい：其频率为 72 MHz，占空比为 50%。 - 通常のテキストと特殊文字（リンク、太字、斜体など）の間：
この フォント は太字スタイルを使用しています。
ここを クリックして 購読してください。 - 英語の半角句読点の後：
Hello, world
- 中文とダッシュの間：
Markdown - 一种高效的写作方式
テキストのスタイル#
- 中英文混在の場合、デフォルトでは中文の全角句読点を使用します。
- 中英文混在の場合、文内に英文の完全な文がある場合は、半角の英文句読点を使用します。
- インラインリンクは通常太字を使用し、読みやすさを向上させます。
- 正確な専門用語を使用してください：
間違い：使用 github 登录
正しい：使用 GitHub 登录 - 中文では角引用符を使用し、通常の引用符の代わりにします：
間違い：华广机器人队，也称为 “野狼队”
正しい：华广机器人队，也称为「野狼队」 - 強調するために句読点を重複して使用しないでください。
書き方のスタイル#
- 必要のない場合は、実体を増やさないでください。
- 読みやすさを向上させるため、長い文を使用することを避け、複数の短い文に分割することができます。
- 論点は根拠を持って述べ、理論だけでなく具体例も示すようにしてください。