テキスト集

ドキュメントの表現で迷ったときの判断材料として、推奨する表記を記載します。

文体

• 「ですます調」で書く
• ただし、「お願いいたします」「お手数ですが」等の過剰な表現は不要

見出しタグ

• 見出しタグはH2以降を利用する
• 利用可能タグはH2、H3、H4までとする

日付の表現

• 「2022年01月23日」のように英数字と年月日で表記する
• 曜日は基本不要だが、曜日を強調したい場合は曜日を含めて記入する

2022年01月23日
2022年01月23日(土)

英数字

• 半角で表記する

Documentation
1st
12年

数値の表現

• 熟語や固有名詞は漢数字
• 数えることができる数字は算用数字

一度に大量のファイルをアップすると、

必ず１つ以上の項目にチェックを入れてください。

「」（鉤括弧）

• メッセージ表示の際に利用
• 引用・語句の強調に利用

「ファイルがアップロードできました」とメッセージが表示されます。
「氏名」フィールドに記入してください。

[]（角括弧）

• 画面名に利用
• リンクやボタンの表示に利用

[更新する]ボタンをクリックします。

>(大なり、グレーターザン)

• 画面遷移の際に利用

会社概要 > 社長メッセージをクリックしてください。

テキストリンク

• 移動先を想起しやすい表現をする
• 「詳細はこちら」などのリンク先を想起しづらい表現は使用しない。

  詳しくは[管理画面ガイド]の[コンテンツを投稿する](https://example.com/example/)をご確認ください。

リスト

• 複数項目を並列で並べる場合に利用

行ったことのある都道府県は以下の通りです。
- 北海道
- 宮城県
- 京都府
- 長崎県

スクリーンショット

• スクリーンショット撮影時は下記要件で対応
  • Webブラウザ：Google Chrome
  • 利用アプリ：Gyazoo
  • 枠線：赤色

注釈

• 本文の内容からそれるが、注意点として書いておきたい時に利用

tip

解決しない場合はお問合せフォームよりご連絡ください。

警告

• 本文の内容からそれるが、警告として書いておきたい時に利用

danger

必ずチェックを入れてから送信をクリックしてください。

コードブロック

• サンプルコードを記載する時に利用

$example = "example";
print $example;

ユーザに作業して頂く際の記入例

ユーザに作業を依頼するときの書き方として、「選択します」「指定します」「入力します」「設定します」の使い分けを説明します。

選択します

• 単独のフィールドの場合利用。チェックボックス/セレクトボックス/ラジオボタン等のフィールドから選ぶ場合に利用

対象の地区を選択します。

指定します

• 単独のフィールドの場合利用。%を設定する場合に利用

1日のうち、学習に割り当てる時間を指定します。

入力します

• 単独のフィールドの場合利用。テキストフィールドやテキストエリアなど、テキストを書かせる場合に利用

「お名前」フィールドに入力します。

設定します

• 複数フィールドがあり、選択や記入などが複数ある場合

プロフィールを設定します。