ドキュメント執筆ルール

執筆上のルール

マニュアルを執筆する上でのルールです。
ルールから逸脱するとCSSが崩れたり読みづらくなったりします。
文体については各マニュアルを参考に合わせる様にお願いします。

見出しについて

• h1(#)…htmlの規則上1ページに1つのため、原則マニュアルの記載では使用しないでください。
• h2(##)…左カラムの目次に載る見出しになります。影付きの白帯とboader-leftのCSSをあてています。
• h3(###)…boader-bottomのCSSを当てていて、黒い下線がつきます。
• h4・h5(####,#####)…太字のサイズ違いです。これ以下の見出しは変化はありません。

画像について

■スクリーンショット
スクリーンショット感を出すために5pxの黒枠を付けて添付しています。
ご入用の際はスクショ画像と共に梅村までご連絡ください。
■図版・アイコンについて
必要に応じて制作します。梅村までご連絡ください。

表組について

列の幅にCSSをあてているので、4列まででまとめてほしいです。ベストは〜3列となっています。

リスト項目について

「親＞子＞子」くらいの入れ子にまとまるようにして欲しいです。
文字の大きさに0.9倍のCSSをあてているので、入れ子にする事で重ねがけされます。
よって、入れ子しまくるととんでもなく文字が小さくなります。

数字の表記について

カウントする数字については「123」のアラビア数字
熟語や固有名詞については「一二三」の漢数字でお願いします。
例）1つ、2つ。第3、第4。
一石二鳥、第一人者など

表記揺れについて

現在確認されている表記揺れは以下の通りです。
どちらに寄せるかは2019/05現在、検討中です。

• 利用・使用…現在ほとんどは「利用」になっていますが、意味合い的に「使用」という表記の方が正しい箇所が多いという説が出ています。
• KAMONOHASHI…単語末尾にスペースあったりなかったりしています。
• 押す・押下・〇〇ボタンから行う

マニュアルの内容について

• 2019.5時点で以下の構成としています。

・user.md...ユーザマニュアル
・admin.md...アドミンマニュアル
・cli.md...cliのマニュアル
・install-and-setup.md...KAMONOHASHIインストールマニュアル
・tutorial.md...チュートリアル