ナレッジの形式 — Markdown
ナレッジの形式 — Markdown
アイノウのナレッジ(知識ベースの1ページ)は、すべて Markdown で保持します。これはアイノウのナレッジの持ち方の、最も基本的な考え方です。
かつての「テーブル型JSON」形式は廃止されました(2026年8月)。表データも Markdown のテーブル記法で持ちます。CSV / Excel を取り込むと Markdown のテーブルに変換されて保存されます(→ No.4.1)。
Markdown — すべてのナレッジの形式
説明・手順・FAQ・概念・統合ページ・早見表など、あらゆる内容を扱います。
- 見出しでセクションに分かれ、チャット回答時の検索単位(チャンク)になる。見出しを小さく区切る ほど検索(Query)精度が上がる
- 先頭に フロントマター(YAML 形式のメタ情報)を持ち、OKF に沿ったメタ情報になる(項目は下記「フロントマター」)
- 編集はブロック形式エディター(→ No.4.2)。Markdown のソースをそのまま書き込みたいときは
.mdファイルのインポート(→ No.4.1)か MCP(→ No.6.1)を使う
制約
| 制約 | 内容 |
|---|---|
| 本文上限 | 262,144 文字 / 80,000 トークン |
| 上限超過時 | エディター保存・MCP 直接書込は超過でエラーになり保存できません。インポート時のみ上限以内に自動分割されます(タイトルに (i/N) が付く) |
| HTML | 使用不可(本文中の生 HTML はエスケープされ、文字としてそのまま表示されます。例外はエディターの表セル内の装飾のみ) |
図表を埋め込む拡張記法
コードブロックで図やグラフを描けます(チャット回答の見やすさが上がります)。
| コードブロック | 用途 |
|---|---|
mermaid |
フロー・シーケンス・クラス・ER 図 |
chart |
Chart.js のグラフ(line / bar / pie 等) |
gantt |
ガントチャート |
json |
配列の配列ならテーブル表示 |
手順は 表+箇条書き、流れは mermaid、数値比較は chart が目安です。
mermaid のラベルはクォートする: ノードのラベル
id[...]/id(...)/id{...}やエッジラベル|...|の中に丸括弧・角括弧・波括弧・記号・改行を含めるときは、必ずダブルクォートで囲みます(例:A["専門家 (あなた)"])。クォートしないと構文エラーになり、図ではなくコードがそのまま表示されます。なお言語名を付け忘れたり、
flowchartのような図の種類を言語名にしてしまった場合でも、レンダラが中身から自動判定して描画を救済します。とはいえ確実性のため、上記の正しい言語名を付けてください。
表データの持ち方
列が決まったデータは Markdown のテーブル記法 で書きます。
- CSV / Excel(
.csv/.xlsx)を取り込むと Markdown のテーブルに変換される(1 ブック 1 ナレッジ。各シートが# {シート名}の H1 セクションになり、空シートはスキップ → No.4.1) .jsonファイル は、配列の配列であれば表に変換され、それ以外はjsonコードフェンスで包まれる- 行の追加・更新は他の本文と同じく MCP の
update-knowledge/append-knowledge、またはエディターの表ブロックで行う
フロントマター(OKF メタ情報)
ナレッジを エクスポート(ダウンロード) すると、本文の先頭に YAML フロントマター(--- で囲むメタ情報)が付与されます。これは Open Knowledge Format(OKF → No.10.2) に沿った形式で、インポート時にも読み取られます(既に先頭フロントマターがある場合は二重付与しない/空の項目は省略)。
| 項目 | 内容 | OKF |
|---|---|---|
type |
本文形式。常に markdown |
OKF キー(OKF は concept 種別、iknow は本文形式を表す) |
no |
章番号(例 1.3) |
iknow 独自 |
title |
タイトル | OKF |
tags |
タグ配列 | OKF |
related_nos |
関連ナレッジの No 配列 | iknow 独自(リンク復元用) |
timestamp |
最終更新日時(ISO8601) | OKF |
書き方の指針
- 主に「読ませる文章」なら → 見出しで細かく区切った Markdown 本文
- 複数の資料を統合して概念ページを作るなら → Markdown 本文
- 列が決まったデータを並べるなら → Markdown のテーブル
- 流れ・関係・数値比較を示すなら → mermaid / chart / gantt
詳しい書き方は No.4.3(ナレッジの書き方と設計)、Markdown 記法の詳細は MCP の get-reference name=markdown-guide を参照してください。