文体・スタイル

みんなで執筆しても同じような文体になるようにするためのガイドラインです。

文体

語末は敬体を使う

🙆🏻‍♂️ 開発にはNode.jsが必要になります。 ❌ 開発にはNode.jsが必要になる。 🙆🏻‍♂️ TypeScriptはオープンソースです。 ❌ TypeScriptはオープンソースである

マークアップ

プログラムにはコード記法を使い、それ以外には使わない

🙆🏻‍♂️ このnew演算子は、/ ❌ このnew演算子は、 🙆🏻‍♂️ nullable coalescing operatorと呼ばれます。 ❌ nullable coalescing operatorと呼ばれます。 🙆🏻‍♂️ 強調するためにcode記法を使ってはいけません。 ❌ 強調するためにcode記法を使ってはいけません。

Capitalization

見出しの英単語は単語1文字目を大文字にする

🙆🏻‍♂️ Literal Types / ❌ Literal types / ❌ literal types 🙆🏻‍♂️ リテラル型(Literal Types) / ❌ リテラル型(literal types) 🙆🏻‍♂️ Literal Typesの使い所

文中の英単語は小文字にする

🙆🏻‍♂️ リテラル型(literal types)とは、 ❌ リテラル型(Literal Types)とは、

固有名詞は本家の表記に習う

🙆🏻‍♂️ JavaScript / ❌ Javascript / ❌ javascript