Markdown を活用して読みやすい文章を作成する

Questetra Version 16.2 では、文字型データ項目のフォームタイプとして [Markdown] が追加されました。

Markdown とは、軽量マークアップ言語の一つです。文章の行頭で #(番号記号) に続けて   (半角スペース)を書くと見出しに変換されるなど、簡単な記号や文字の組み合わせで、見出し、箇条書き、外部サイトへのリンク、強調表示などを表現できます。Markdown で記述することで、読みやすく、理解しやすい文章を作成できるようになります。

今回は、[文字型(Markdown)]データ項目に Markdown で記述する方法や、Markdown で書かれた文章を確認する方法を紹介します。

Markdown は文章構成を簡単に表現可能

[文字型(Markdown)]は、見出しや箇条書きなどを使って文章の構成を簡単に表現できるため、内容を塊ごとに整理しやすくなります。さらに、太字などの文字装飾も手軽にできるため、[文字型(複数行)]と比べてメリハリのついた文章を作成しやすいのが特徴です。

文章構成の表現や文字の装飾は、後述の簡単な記号の追加で実現できます。また[文字型(Markdown)]データ項目では、処理フォームでの際、[編集]に Markdown で記述すると、記述したMarkdown の解釈結果が[プレビュー]に即時に表示されます。

[文字型(Markdown)] データ項目への入力結果を、開始したプロセスの[詳細]やタスク処理フォームで確認する際は、入力時のプレビューと同じ形式で表示されます。

簡単な記号の追加で多彩な表現に変換!

では、実際に文字型(Markdown)データ項目へ Markdown を使って文章を記入していきましょう。

見出しは、 ”#” + 半角スペース

冒頭でも書いた通り、行頭に #(番号記号)と  (半角スペース)を入れるとその行は見出しに変換されます。 # の数が多いと、より小さな見出しになります。

段落は、空行で区切る

段落を区切るには、空行(何も書かれていない行)を入れます。

箇条書きは、”-” または “1.” + 半角スペース

箇条書きは、行頭に -(ハイフン)と  (半角スペース)を書き、それから項目を書きます。

 - の前に、スペースを2つ入れると、箇条書きレベルを一段下げることができます。

番号付きの箇条書きにする場合、行頭を 《数字》.(ピリオド)、  (半角スペース)で始めてください。

表は、”|” と “-” で区切る

表(テーブル)を作成する場合、 |(パイプ)と -(ハイフン)を使用して区切ります。

基本の表の記述方法は以下の通りです。

| 見出し1 | 見出し2 | 見出し3 |
|---------|---------|---------|
| 内容A   | 内容B   | 内容C   |
| 内容D   | 内容E   | 内容F   |

このように記述すると、以下のような表が作成されます。

また、: を用いることで、列の配置(左寄せ、中央寄せ、右寄せ)を指定できます。

文字の装飾は記号で挟む

Markdown では、以下のように記号で挟むことで文字の装飾ができます。

  • 太字**太字**
  • Italic(斜体) → *Italic*(斜体)(全角文字など環境によっては効果のない文字もあります)
  • 取り消し線~~取り消し線~~
  • コード → `コード`

その他、よく使う Markdown の記法については、Markdown サンプル(初級編)に、Questetra でのMarkdown 全仕様については、Markdown サンプル(上級編)に載せておりますので、参考にしてください。

まとめ

Questetra Ver.16.2 では、業務マニュアルに加え、Markdown に対応したデータ項目が追加され、またデータ項目の説明欄でも Markdown を使用できるようになりました。Markdown を活用することで、情報が見やすく整理された、視認性の高いドキュメントを作成できます。

Markdown を活用し、箇条書き、表などを適切に使いこなしながら、効果的なドキュメントを作成しましょう

上部へスクロール

Questetra Supportをもっと見る

今すぐ購読し、続きを読んで、すべてのアーカイブにアクセスしましょう。

続きを読む