TeamLog の記事基盤には、記事の構造をあらかじめ決めておく「フォーマット」という仕組みがあります。フォーマットは4つのテンプレートから選んで作り始められます。この記事では、その4つがそれぞれどんな構造を持ち、どういう記事に向くのかを整理します。
| テンプレート | 含まれるキー | 向いている記事 |
|---|---|---|
| 比較記事 | intro / comparison(表) / detail / faq / verdict | 選択肢を並べて比べる記事 |
| How-to | intro / steps(手順) / caveats / faq / summary | 手順を順番に説明する記事 |
| FAQ集 | intro / faq / related(リンク) | 質問と答えを並べる記事 |
| 空から作る | なし | 既存のどれにも当てはまらない構造を自分で組む場合 |
比較表と FAQ が入っている理由
比較記事とHow-toとFAQ集の3つには、いずれも faq 型のキーが入っています。質問と答えの組は構造化データとして出力されるため、内容をそのまま抜き出せる形になります。
キーの型は7種類
キーには string / richtext / table / list / faq / steps / links の7つの型があります。table は比較表、steps は手順、links は関連リンクとして、それぞれ専用の構造で保存・描画されます。
- テンプレートを選んだ後にキーを変えられますか
- 変えられます。テンプレートは出発点で、選んだあとに行を足す・消す・並べ替えることができます。
- キーを削除するとどうなりますか
- 公開済み記事の表示から、そのキーのセクションが表示されなくなります。保存前に影響を受ける記事の本数が表示され、確認しないと保存できません。
- フォーマットは後から追加できますか
- できます。記事の種類ごとに別のフォーマットを作り、記事ごとにどのフォーマットで書くかを指定します。
選択肢を比べる記事なら比較記事、手順を説明するならHow-to、質問に答える形ならFAQ集が出発点になります。どれにも当てはまらない構造が必要なときだけ、空から作ることになります。