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 — 建立条目

1. 选择书籍 slug：将书名转换为小写 kebab-case（例如，Build a Large Language Model (From Scratch) → build-a-large-language-model-from-scratch）。
2. 创建 books/<book-slug>/。
3. 将源 PDF 放入条目中，命名为 book.pdf——每章中的论述都必须可通过该文件核实。
4. 创建条目 README.md，包含固定的书籍信息和以下部分：
   • 书籍信息——书名、作者、出版社、年份、ISBN、页数、语言。
   • 简介——介绍本书内容及适读对象。
   • 目录——链接到每章文件和所有附录。附录应作为此 README.md 的部分，而非同级文件。
   • 参考资料——源 PDF 和出版社页面。
5. 添加条目 frontmatter——仅包含最少信息，用作内容过时的信号；若存在 upstream，它应指向出版社页面（而非仓库）：

   ---
   upstream: https://www.manning.com/books/<book>
   last_updated: <YYYY-MM-DD>
   ---
   

步骤 2 — 撰写章节

按本书的阅读顺序，逐章处理：

1. 创建 NN-<chapter>.md（索引补零，标题使用 kebab-case）：包含 frontmatter、章节标题、本章自身小节的目录，然后是各小节内容。
2. 总结并注明出处——用自己的语言复述书中内容，并引用书籍（作者、章节）。除出版社许可允许个人学习使用的范围外，切勿重现书中文字、代码清单或插图。
3. 在能清晰呈现机制、流程或数据路径的地方添加 mermaid 图表。完成前渲染每个图表，以确认其有效且清晰易读：

   mermaid-render /tmp/d.mmd   # a clean, non-empty SVG/PNG means the block renders on GitHub
   

4. 保持条目中的目录同步：章节文件一旦存在，就立即添加相应链接。

步骤 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 问题驱动，则在推送成功后将其标记为完成。

约束

• 任何时候都不得包含凭据、令牌或特定集群的数据。
• 一本书只使用一个规范来源；所有非显而易见的论述都必须注明出处，出处汇总在条目的“参考资料”部分。
• 章节内容须从头到尾清晰易读、注明出处，并在有帮助时配有图表，且已链接到条目目录，方可视为完成。