ナレッジの書き方と設計
ナレッジの書き方と設計
No(章番号)
- ドット区切りの数値(例:
1,1.2,1.2.3) - 最大5階層・20文字
- 一覧の既定ソートキー
- 目次ナレッジは
0を予約
タグ
- 自由な文字列で分類
- 一覧のタグ絞り込みに使用
- 入力時に既存タグの候補が表示される
関連ナレッジ
- エディターの「関連ナレッジ」ドロワーで手動リンク
- 回答精度とナビゲーションの向上に有効
- 本文中に他ページへの参照を書かず、関連ナレッジ機能でリンクするのが推奨
Markdown記法
ナレッジ本文は内部で Markdown として保存・表示されますが、ナレッジエディターで Markdown を直接書くことはできません(ブロック形式エディターで編集)。
エディターでの編集
- 段落・リスト・表・コードブロック等をブロック単位で追加・編集
- セクション見出しは画面上部のタイトル入力で編集(本文中に
#見出しは追加できません) - 「AIで修正」で自然言語の指示に基づくリライトも可能(No.4.7)
Markdown原稿の取り込み
既存の Markdown ファイルやリポジトリの原稿は インポート で取り込みます。
- ファイル:
.md/.txt/.html等(No.4.1) - GitHub: リポジトリ内の Markdown ファイル
取り込み後はエディターでブロック編集できます。エクスポート(ダウンロード)で Markdown ファイルとして出力することも可能です(No.4.10)。
対応している記法(保存形式)
- 見出し(
#〜######)でセクション分割 - 太字・斜体・マーカー・リンク・表・コードブロック
- タスクリスト(
- [ ]/- [x]) - Mermaid図・Chart.js・埋め込みHTML
テーブル形式JSON
スプレッドシート取り込み等で [[cell,...],...] 形式のJSONが保存される場合があります。ナレッジエディターの表ブロックで編集します。
設計のコツ
- 1ページ1テーマに分割する
- タイトルと冒頭で要点を明示する
- 専門用語は初出時に説明する
- No体系で章立てを設計する