ドキュメントルールと記法
わんコメのドキュメント整備のルールと記法について解説します
タイトル
タイトルは言い切りの形にします
「です」「ます」「～しよう」といった末尾はないもので統一します
導入文
本文１行目に必ずそのページの簡単な説明を記載します
これはページ一覧の説明文に使われます
ページ一覧になった時の表示文字数は２５文字までのため、長くなっても大丈夫ですが２５文字目までである程度区切りや意味の分かる形にできるといい感じです
見出し
見出しは必ず見出し2から開始してください（1は使用しません）
見出しがついた項目はジャンプリンクが付与されるようになります
見出し名についてもタイトルと同じように言い切りで「です」「ます」「～しよう」といった末尾はないもので統一します
本文
「です」「ます」調で統一します
１行文の場合、末尾の句点（。）をつけないでください（なるべく改行をする）
文字装飾
文字装飾は太字と下線のみとします
文字色・背景色は反映されませんのでご注意ください
強調
重要な事項は強調することができます
Notionの「コールアウト」フォーマットで下記のように記載します
絵文字によって色などが変わるため下記の絵文字以外は非対応です
注目させたい内容
情報として記載したい内容
注意する内容
警告する内容
※「コールアウトの」の本番環境での表示サンプルは、本ページ下部のスクリーンショットで確認できます
リンク
外部リンクはhttpsから始まるURLを使用してください
リンクそのままではなくリンク先のタイトルや内容を記載したものにリンクをつけてください
ドキュメント同士をリンクする場合は下記のように//から始まるURLで記載してください
//guide/install
//screen/main
各ページのURLはデータテーブルのドキュメントのSlug列を確認してください
画像
png形式で統一します
画像名は任意で構いません
画像に説明を付ける場合は説明の下においてください
例
OK： 下図のようになります
NG： 上図のようになります <- 説明の上に画像がある
※例外として画面説明だけは上に画像、下に説明とします
画像内の注釈は「Noto Sans Japanese」フォントで、番号は太字18pt（Bold）、テキストは通常18pt（Regular）で記載してください
色は#FB0465としてください
Noto Sans Japaneseはこちらからダウンロードできます
https://fonts.google.com/noto/specimen/Noto+Sans+JP
矢印や罫線は#000000、#ffffff、#FB0465の３色の中で作成し他の色は使用しないでください
大きさや太さ、形状については指定しません
表
表を作成する場合は下記のように先頭に見出し行を追加してください
| 列A | 列B |
|---|---|
| A-1 | B-1 |
| A-2 | B-2 |
動画
動画は直接アップロードせずYouTubeにアップロードしてください
YouTubeの視聴URLを貼り付け「埋め込みを作成する」で下記のように埋め込みしてください
ご自身のチャンネルがない場合やアップしたくない場合などは代行してわんコメチャンネルにアップロードしますのでアスティまでご連絡ください
ファイル
ファイルの添付やアップロードは禁止です
制限
下記内容はドキュメントに反映されません
- 文字色
- 背景色
- Notionノートのページリンク
- データベース
- メンション
- リマインダー
- 数式
- Webブックマーク
- ファイル
- オーディオ
- 動画（YouTubeリンク除く）
このページのプレビュー
その他
上記以外に不明な点があればDiscordのドキュメント整備チャンネルでご質問ください！