コンテンツ執筆時のルール
最終更新
最終更新
ルールを設定する目的は、コンテンツ全体の統一感を出したり、定まったルールの元でコンテンツを書くことで、読者にとって読みやすいコンテンツにすることです。
しかし、コンテンツを書くためのハードルを上げたくもないので、ルールを多く管理したくもありません。ルールの設定は、必要最小限に抑えるようにしましょう。
なお、このページに記載するルールは基本原則ではありますが、記事の特性上ルールから外した書き方をしたい場合は、従う必要はありません。
以下、各ルールごとに説明を記載します。
例えば、次のようなコード例におけるルールです。
この例では、zshのデフォルトのプロンプトを記載していますが、コマンドラインで実行するコードでは、それが分かるように、プロンプトを記載します。
bashを普段使っている人が記事を書くときに、bashのプロンプトを記載するのはOKとします。
また、インフラ系の記事などでは、rootユーザーのプロンプトを明示的に記載したい場合もあると思いますが、その場合は、[root]# などをプロンプトとして記載します。
上の図のように、gitbook.comでは、見出しのスタイルとして、Heading1、Heading2、Heading3が使えますが、これは必ずしもH1タグ、H2タグ、H3タグになるわけではありません。
目次を適切に管理しやすくするために、記事上の見出しは、Heading1から使い、その内部で区切りをつけたい場合は、Heading2、Heading3と階層を下げてコンテンツを記載してください。
gitbook.comではリンクに下線がつかないことから、リンクに気付きにくいです。
そこで、リンクの文字列の書式は、以下の例のように太字としてください。
例：本サイトの更新情報は、Twitterの株式会社プレセナ・ストラテジック・パートナーズエンジニア公式で発信しています。ご確認ください。
