knowledge-base-add-book について
knowledge-base-add-book は、出版済みの技術書を knowledge-base リポジトリの `books/` に追加するワークフロースキルです。出典を示した章ごとの学習資料を作成し、リポジトリの索引に登録する手順を案内します。
主な機能
- 01書籍セクションの規則を先に確認
- 02構成に沿った書籍エントリー作成
- 03章ごとの要約と出典明記
- 04理解に役立つ Mermaid 図のレンダリング
- 05索引への書籍登録
活用シーン
- 01ナレッジベースに技術書を追加
- 02章にリンクした学習ノートを作成
- 03書籍エントリーをリポジトリ規則に準拠させる
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/インストール後、Claude Code で/knowledge-base-add-bookを入力して読み込まれたか確認します。
詳細
ナレッジベースに書籍を追加する
出版済みの技術書を、章ごとに忠実に学習する内容として books/ セクションに追加します。ナレッジベースのルートにある
README.md が準拠すべき仕様です。レイアウト、セクションのルール、インデックステーブルが記載されています。このスキルは、書籍を追加するための
ワークフローです。書籍の執筆規則を繰り返し説明するものではありません。必須の構成とスタイルを定めているセクション固有の基準書、books/README.md を
最初に読んでください。
ナレッジベースの場所
ナレッジベースのリポジトリ内で作業します。正規のローカルチェックアウト先は ~/code/knowledge-base です。存在しない場合は、git clone [email protected]:mmontes11/knowledge-base.git ~/code/knowledge-base を実行してください。以下のすべてのパスは
リポジトリのルートからの相対パスです。
ステップ 0 — セクションのルールを読む
何かを書く前に books/README.md を読んでください。必須の書籍形式の構成、目次の追跡ルール、執筆規則（要約して出典を明記し、書籍全体をそのままコピーしないこと。図は推奨）を定めています。これに厳密に従ってください。
ステップ 1 — エントリーを作成する
- 書籍のスラッグを決めます。タイトルを小文字のケバブケースにします（例：Build a Large Language Model (From
Scratch) →
build-a-large-language-model-from-scratch）。 books/<book-slug>/を作成します。- エントリー内にソース PDF を
book.pdfとして配置します。各章の主張をこの PDF と照合できる必要があります。 - 固定の書籍情報と以下のセクションを含むエントリーの
README.mdを作成します。- 書籍情報 — タイトル、著者、出版社、出版年、ISBN、ページ数、言語。
- はじめに — 書籍の内容と対象読者。
- 目次 — 各章のファイルと付録へのリンク。付録はこの
README.md内のセクションとし、別ファイルにはしません。 - 参考資料 — ソース PDF と出版社のページ。
- エントリーのフロントマターを追加します。最小限の内容にし、古さを示すシグナルとしてのみ使用します。
upstreamがある場合は、 リポジトリではなく出版社のページを指定します。--- upstream: https://www.manning.com/books/<book> last_updated: <YYYY-MM-DD> ---
ステップ 2 — 各章を書く
書籍の読書順に、各章について以下を行います。
NN-<chapter>.md（ゼロ埋めのインデックスとケバブケースのタイトル）を作成します。フロントマター、章タイトル、その章にある書籍独自のセクションの 目次、続いて各セクションの内容を記載します。- 要約して出典を明記します。書籍の内容を独自の言葉で述べ、書籍（著者、章）を引用します。個人利用・学習目的で出版社のライセンスが許可する範囲を超えて、書籍の文章、コードリスト、図を再現しないでください。
- 仕組み、フロー、データ経路をわかりやすく示せる箇所には、mermaid 図を追加します。完了前に各図をレンダリングし、正しく表示され、読みやすいことを確認してください。
mermaid-render /tmp/d.mmd # a clean, non-empty SVG/PNG means the block renders on GitHub - エントリーの目次を常に同期させます。章ファイルが存在した時点で、その章へのリンクを追加します。
ステップ 3 — 書籍を登録する
ルート README.md の 追跡対象書籍テーブルに行を追加します（列：書籍、著者、ソース）。books/<book-slug>/README.md へのリンクを設定してください。書籍はプロジェクトに依存せず、リポジトリのルートに配置します。projects/ の下には置かず、「追跡対象プロジェクト」テーブルにも含めず、月次メンテナンスの対象外とします。
ステップ 4 — 提出する
- 慣例に沿ったメッセージでコミットします：
docs(books/<book-slug>): <summary>（例：docs(books/build-a-large-language-model-from-scratch): summarize chapter 3 — attention）。 mainに直接プッシュします。ナレッジベースはプルリクエストではなく、直接プッシュで管理されています。- Multica の issue がこの作業のきっかけであれば、プッシュが反映された後に完了済みにします。
制約
- 認証情報、トークン、クラスター固有のデータは、決して含めないでください。
- 書籍ごとに正規のソースは 1 つです。明白でない主張にはすべて出典を明記し、エントリーの「参考資料」にまとめます。
- 章は、最初から最後まで読みやすく、出典が明記され、役立つ箇所に図があり、エントリーの目次からリンクされていれば完成です。