knowledge-base-query
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseQuery the knowledge base
查询知识库
Read information from the knowledge base — projects, books, and foundational topics — and answer grounded in
it. The root is the index: it maps names to folders, so start there and go straight to the
target. Do not read the whole repository; use the indexes to open only the file(s) the question needs.
README.md从知识库读取信息——包括项目、书籍和基础主题——并以其中的内容为依据进行回答。根目录的 是索引:它将名称映射到文件夹,因此应从那里开始,直接定位目标。不要读取整个仓库;使用索引只打开回答问题所需的文件。
README.mdLocate the knowledge base
定位知识库
Work inside the knowledge-base repository. The canonical local checkout is ; if it
is absent, . All paths below are
relative to the repository root.
~/code/knowledge-basegit clone git@github.com:mmontes11/knowledge-base.git ~/code/knowledge-base在 knowledge-base 仓库中操作。标准的本地 checkout 位于 ;如果该目录不存在,则执行 。以下所有路径均相对于仓库根目录。
~/code/knowledge-basegit clone git@github.com:mmontes11/knowledge-base.git ~/code/knowledge-baseStep 0 — Find it in the index
第 0 步——在索引中查找
The root holds the indexes:
README.md- Tracked projects table — maps each project to its folder and its upstream URL.
projects/<category>/<project>/ - Tracked books table — maps each book to its folder.
books/<book>/ - Tracked foundational knowledge table — maps each foundational topic to its folder.
foundation/<topic>/
If the thing you were asked about is not in the index, say so — the knowledge base does not cover it — and
stop. If a Tracked projects row exists and further research would help, surface its upstream URL.
根目录的 包含以下索引:
README.md- 跟踪项目表——将每个项目映射到 文件夹及其 upstream URL。
projects/<category>/<project>/ - 跟踪书籍表——将每本书映射到 文件夹。
books/<book>/ - 跟踪的基础知识表——将每个基础主题映射到 文件夹。
foundation/<topic>/
如果所询问的对象不在索引中,应明确说明知识库未涵盖该内容,然后停止。如果“跟踪项目”表中存在相应条目,且进一步研究会有所帮助,则应提供其 upstream URL。
Step 1 — Read the right file
第 1 步——读取正确的文件
Go straight to the file that answers the question:
| Question | Read |
|---|---|
| What is the project / what problem does it solve | |
| What is its API / resource / CLI surface | |
| What is the latest release / what changed | |
| What features does it have | |
| How is it architected | |
| What a book teaches / a chapter's content | |
| How a concept actually works | |
直接读取能够回答问题的文件:
| 问题 | 读取内容 |
|---|---|
| 项目是什么/它解决什么问题 | |
| 它的 API/资源/CLI 接口是什么 | |
| 最新版本是什么/有哪些变化 | |
| 它有哪些功能 | |
| 它采用了什么架构 | |
| 一本书讲了什么/某一章的内容 | |
| 某个概念的实际工作原理 | |
Step 2 — Answer
第 2 步——回答
- Answer from the knowledge base, citing the file you read and, where useful, its frontmatter so the reader knows how current it is.
last_updated - For projects the KB links rather than copies upstream. If the entry is thin or stale, say so and surface the upstream link from the Tracked projects table so the reader can verify.
- If the question spans several files (e.g. "give me the picture of <project>"), read first, then pull in only the specific files the question needs.
README.md
- 基于知识库回答问题,并引用已读取的文件;必要时引用其 frontmatter,让读者了解内容的时效性。
last_updated - 对于项目,KB 只是提供 链接,而不是复制 upstream 内容。如果条目内容过于简略或已经过时,应明确说明,并提供“跟踪项目”表中的 upstream 链接,以便读者核实。
- 如果问题涉及多个文件(例如“介绍 <project> 的整体情况”),先读取 ,然后只提取回答问题所需的具体文件。
README.md
Scope
范围
This skill is read-only — it never edits, adds, or removes knowledge-base content. Adding a project or a
book, and refreshing a project, belong to the and
skills.
knowledge-base-add-projectknowledge-base-add-book此 skill 是只读的——它绝不会编辑、添加或删除知识库内容。添加项目或书籍以及更新项目,分别属于 和 skill。
knowledge-base-add-projectknowledge-base-add-book