wiki-ingest

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Wiki Ingest

维基导入流程

Add a source to the wiki. Read it, discuss with the user, write a summary page, update entity/concept pages, and maintain the index, overview, and log.
向维基添加来源。阅读来源内容、与用户讨论、撰写摘要页面、更新实体/概念页面,并维护索引、概览和日志。

Pre-condition

前置条件

Search for
SCHEMA.md
starting from the current directory and upward, or in common wiki locations (
~/wikis/
). If not found, tell the user to run
wiki-init
first.
Read
SCHEMA.md
to learn: wiki root path, page frontmatter format, cross-reference convention, log entry format, index category taxonomy.
从当前目录向上搜索
SCHEMA.md
,或在常见维基目录(
~/wikis/
)中查找。如果未找到,请告知用户先运行
wiki-init
阅读
SCHEMA.md
以了解:维基根路径、页面前置元数据格式、交叉引用规则、日志条目格式、索引分类体系。

Process

操作流程

1. Accept the source

1. 接收来源

The source can be:
  • File path — read it directly; copy to
    raw/<filename>
    if not already there
  • URL — use the
    browse
    skill to fetch it; save to
    raw/<slug>.<ext>
  • Pasted text — use what was provided
来源可以是:
  • 文件路径 — 直接读取;若尚未存放在指定位置,复制到
    raw/<filename>
  • URL — 使用
    browse
    技能获取内容;保存到
    raw/<slug>.<ext>
  • 粘贴文本 — 使用用户提供的内容

2. Read the source in full

2. 完整阅读来源

Read all content. For long sources, read in sections. Do not skip.
阅读所有内容。对于长文档,分段阅读,请勿跳过任何部分。

3. Surface takeaways — BEFORE writing anything

3. 提炼核心要点——在开始撰写任何内容之前

Tell the user:
  • 3-5 bullet points of key takeaways
  • What entities/concepts this introduces or updates
  • Whether it contradicts anything already in the wiki (read
    wiki/index.md
    and relevant pages to check)
Ask: "Anything specific you want me to emphasize or de-emphasize?"
Wait for the user's response before proceeding.
告知用户:
  • 3-5条核心要点的项目符号
  • 本次导入引入或更新的实体/概念
  • 是否与维基中已存在的内容冲突(需查阅
    wiki/index.md
    及相关页面确认)
询问:"是否有需要特别强调或弱化的内容?"
等待用户回复后再继续操作。

4. Generate the slug

4. 生成slug

Lowercase, hyphens, no special characters. Example: "Attention Is All You Need" →
attention-is-all-you-need
全部小写,用连字符连接,无特殊字符。 示例:"Attention Is All You Need" →
attention-is-all-you-need

5. Write the source summary page

5. 撰写来源摘要页面

Write
wiki/pages/<slug>.md
:
markdown
---
title: <source title>
tags: [<relevant tags>]
sources: [<slug>]
updated: <today>
---
创建
wiki/pages/<slug>.md
markdown
---
title: <source title>
tags: [<relevant tags>]
sources: [<slug>]
updated: <today>
---

<Source Title>

<Source Title>

Source: <original URL or file path> Date ingested: <today> Type: <paper | article | transcript | code | other>
来源: <原始URL或文件路径> 导入日期: <today> 类型: <paper | article | transcript | code | other>

Summary

摘要

<2-3 paragraph synthesis — your own words, not abstract copy-paste>
<2-3段原创合成内容——请勿直接复制粘贴摘要>

Key Takeaways

核心要点

  • <bullet>
  • <bullet>

Entities & Concepts

实体与概念

<list of entities/concepts as [[slug]] links>
<以[[slug]]链接形式列出的实体/概念>

Relation to Other Wiki Pages

与其他维基页面的关联

<how this connects to or updates existing knowledge> ```
<本内容如何关联或更新现有知识>
undefined

5b. Cite as you write — do not skip

5b. 撰写时同步引用——请勿跳过

While drafting the Summary, Key Takeaways, and any other prose section, every non-common-knowledge factual claim must carry a footnote. Read the Citations section in
SCHEMA.md
for the full convention.
Two citation kinds, three valid targets:
Quote:     [^N]: <target> <locator> — "<verbatim quote>"
Synthesis: [^N]: <target> <locator> [synthesis] — <what supports the claim>

<target> is one of:
  [[source-slug]]      — a source wiki page (preferred for the source you're ingesting)
  raw/<file>           — a path, for drive-by citations to other local files
  <URL>                — a live URL or post
For the source being ingested, use
[[<this-source-slug>]]
wiki-ingest
is creating that page now, so the target exists by the time the page is read.
If you cannot produce either citation kind for a claim, you do not have a citation. Find one, weaken the claim ("the paper suggests..."), or drop it.
Footnotes go at the bottom of the page, below all sections. Number them sequentially in order of first reference.
在撰写摘要、核心要点及其他文本章节时,所有非常识性的事实性陈述必须添加脚注。查阅
SCHEMA.md
中的引用部分了解完整规则。
两种引用类型,三种有效引用目标:
直接引用:     [^N]: <target> <locator> — "<原文引用>"
内容合成: [^N]: <target> <locator> [synthesis] — <支持该陈述的依据>

<target> 可选类型:
  [[source-slug]]      — 维基中的来源页面(优先用于当前导入的来源)
  raw/<file>           — 文件路径,用于引用其他本地文件
  <URL>                — 在线URL或帖子
对于当前导入的来源,使用
[[<this-source-slug>]]
——
wiki-ingest
正在创建该页面,因此当页面被读取时,引用目标已存在。
如果无法为某个陈述添加上述任一类型的引用,则该陈述缺乏依据。需补充引用、弱化陈述(如“该论文表明……”)或删除该陈述。
脚注需放在页面底部,所有章节之后。按首次引用顺序依次编号。

5c. Self-check before continuing

5c. 继续前的自我检查

Re-read the draft once. Scan for unfootnoted factual claims — this is the most common failure mode in long ingest sessions. For each, add a footnote or revise the wording. Only then move on to entity pages.
重新阅读草稿,扫描未添加脚注的事实性陈述——这是长文档导入过程中最常见的失误。针对每个此类陈述,添加脚注或修改措辞。完成检查后再处理实体页面。

6. Update entity and concept pages

6. 更新实体与概念页面

For each entity/concept touched by this source:
  • Page exists: Read it, add to or update the relevant section, add this source to frontmatter
    sources
    list, update
    updated
    date
  • Page doesn't exist: Create it:
markdown
---
title: <Entity or Concept Name>
tags: [entity | concept]
sources: [<this-source-slug>]
updated: <today>
---
对于本次来源涉及的每个实体/概念:
  • 页面已存在: 阅读页面内容,添加或更新相关章节,将本次来源添加到前置元数据的
    sources
    列表中,更新
    updated
    日期
  • 页面不存在: 创建页面:
markdown
---
title: <Entity or Concept Name>
tags: [entity | concept]
sources: [<this-source-slug>]
updated: <today>
---

<Name>

<Name>

Description

描述

<synthesis across all sources that discuss this>
<综合所有提及该实体/概念的来源内容>

Appearances in Sources

在来源中的出现

  • [[source-slug]] — <one-line note>
  • [[source-slug]] — <一行说明>

Related Concepts

相关概念

  • [[related-slug]] — <relationship>
undefined
  • [[related-slug]] — <关联关系>
undefined

7. Backlink audit — do not skip

7. 反向链接审计——请勿跳过

Scan ALL existing pages in
wiki/pages/
for any that mention this source's entities/concepts but don't yet link to the new page. Add
[[new-slug]]
references where appropriate.
This is the step most commonly skipped. A compounding wiki's value comes from bidirectional links.
扫描
wiki/pages/
中的所有现有页面,查找任何提及本次来源实体/概念但尚未链接到新页面的内容。在合适的位置添加
[[new-slug]]
引用。
这是最常被跳过的步骤。双向链接是维基价值持续增长的关键。

8. Update
wiki/index.md

8. 更新
wiki/index.md

Add an entry under the correct category:
- [[<slug>]] — <one-line summary> _(ingested <date>)_
For any new entity/concept pages created, add those too.
在正确分类下添加条目:
- [[<slug>]] — <一行摘要> _(导入日期 <date>)_
对于所有新创建的实体/概念页面,也需添加到索引中。

9. Update
wiki/overview.md

9. 更新
wiki/overview.md

Re-read the current overview. If this source:
  • Introduces a significant concept: add it to "Key Entities / Concepts"
  • Shifts the overall understanding: update "Current Understanding"
  • Raises a new question: add it to "Open Questions"
Update the frontmatter
updated
date.
重新阅读当前概览内容。如果本次来源:
  • 引入了重要概念:添加到“核心实体/概念”部分
  • 改变了整体认知:更新“当前认知”部分
  • 提出了新问题:添加到“待解决问题”部分
更新前置元数据中的
updated
日期。

10. Append to
wiki/log.md

10. 追加到
wiki/log.md

undefined
undefined

[<today>] ingest | <source title>

[<today>] ingest | <source title>

Pages written: <slug> Pages updated: <comma-separated list>
undefined
创建页面: <slug> 更新页面: <逗号分隔的列表>
undefined

Common Mistakes

常见错误

  • Appending chronological updates instead of editing in-place — Wiki pages are living documents, not journals. Do not add sections like
    ## April 27 update:
    or
    **Update:**
    followed by new content. Update the relevant section in-place, bump the
    updated
    frontmatter date, and record what changed in
    log.md
    . The log is the append-only record; pages are the current truth.
  • Skipping the backlink audit (step 7) — A wiki's value compounds through bidirectional links. Always scan existing pages for entities this source introduces.
  • Summarizing the abstract instead of synthesizing — The Summary section should reflect your own synthesis, not a rephrased abstract.
  • 按时间顺序追加更新而非原地编辑 — 维基页面是动态文档,而非日志。请勿添加类似
    ## 4月27日更新:
    **更新:**
    的章节及后续内容。应原地更新相关章节,更新前置元数据的
    updated
    日期,并在
    log.md
    中记录变更内容。日志是仅追加的记录,页面是当前的权威内容。
  • 跳过反向链接审计(步骤7) — 维基的价值通过双向链接实现增长。务必扫描现有页面,查找本次来源引入的实体。
  • 仅摘要原文而非进行内容合成 — 摘要部分应体现你的原创合成内容,而非改写原文摘要。

11. Report to user

11. 向用户汇报

  • Summary page:
    wiki/pages/<slug>.md
  • Entity/concept pages created or updated: <list>
  • Pages that received backlinks: <list>
  • Index and overview updated
  • 摘要页面:
    wiki/pages/<slug>.md
  • 创建或更新的实体/概念页面:<列表>
  • 添加反向链接的页面:<列表>
  • 索引和概览已更新