llm-wiki
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseLLM Wiki
LLM 维基
Build a persistent, source-grounded wiki whose synthesis compounds over time. Read the original idea when you need its rationale, examples, or optional suggestions.
构建一个持久化、基于源文档的维基,其内容会随着时间不断整合。当你需要了解其原理、示例或可选建议时,请阅读原始构想。
Set Up the Wiki
搭建维基
- Ask the user for the wiki's purpose, domain, source location, desired outputs, and review style.
- Create or use a Git repository as the wiki root. Keep human-curated source files in inside that root. Keep the LLM-maintained Markdown pages alongside
raw/so sources, citations, and history travel together.raw/ - Create a schema or agent-instruction file such as . Define the smallest useful domain structure: page types, naming rules, relative-link and citation conventions, and the ingest, query, lint, compact, and commit workflows.
AGENTS.md - Create as the root index. Start with a flat directory and only the initial pages the domain needs.
README.md - Commit the initial wiki as one coherent change.
Keep the schema adaptable. Evolve it when repeated work shows a better convention, and explain the change in the commit message.
- 询问用户维基的用途、领域、源文件位置、期望输出以及审核风格。
- 创建或使用一个Git仓库作为维基根目录。将人工整理的源文件存放在根目录下的文件夹中。将LLM维护的Markdown页面与
raw/放在同一层级,以便源文件、引用和历史记录同步管理。raw/ - 创建一个架构或Agent指令文件,例如。定义最小可用的领域结构:页面类型、命名规则、相对链接和引用规范,以及导入、查询、检查、压缩和提交工作流。
AGENTS.md - 创建作为根索引。初始采用扁平目录结构,仅包含该领域所需的初始页面。
README.md - 将初始维基作为一个连贯的变更提交。
保持架构的适应性。当重复工作表明存在更优规范时,逐步演进架构,并在提交信息中说明变更原因。
Preserve the Contracts
遵守约定
- The human curates sources, sets direction, asks questions, and chooses how much review to perform.
- The LLM writes and maintains the wiki. It handles summaries, synthesis, cross-links, consistency, indexing, structure, and history.
- Treat files in as immutable. Read and cite them, but never rewrite, rename, or delete them during wiki work.
raw/ - Cite raw sources with standard relative Markdown links close to the claims they support. Preserve source-specific disagreement and distinguish source facts from new analysis.
- Use standard relative Markdown links such as , not wikilinks. When moving or renaming a page, fix every inbound link in the same change.
[Page](page.md) - is the landing page and content map. List every root page with a link and short description, organized for the domain. Read it first when navigating or answering a query. Update it whenever pages are created, renamed, moved, deleted, or materially changed.
README.md - Git history is the chronological log. Do not create . Finish each wiki-changing operation with one commit that contains the wiki changes and their history entry together. Use a conventional title and a body that explains what changed and why.
log.md
- 人工负责整理源文件、设定方向、提出问题,并选择审核的程度。
- LLM负责编写和维护维基。它处理摘要、内容整合、交叉链接、一致性检查、索引、结构梳理和历史记录管理。
- 将中的文件视为不可变文件。在维基维护过程中,仅可读取和引用这些文件,不得重写、重命名或删除。
raw/ - 使用标准的Markdown相对链接在相关声明附近引用源文件。保留源文件中的不同观点,区分源文件事实与新分析内容。
- 使用标准Markdown相对链接,如,而非维基链接。移动或重命名页面时,需在同一变更中修复所有入站链接。
[Page](page.md) - 是维基的登陆页和内容地图。列出所有根页面的链接和简短描述,并按领域分类组织。导航或回答查询时,首先阅读该文件。当页面被创建、重命名、移动、删除或发生实质性变更时,更新该文件。
README.md - Git历史记录是 chronological 日志。无需创建。每次维基变更操作完成后,提交包含维基变更及其历史记录的单次提交。使用规范的标题和说明变更内容及原因的正文。
log.md
Ingest a Source
导入源文件
- Read the new file in and the schema or agent instructions. Do not change the source.
raw/ - Read , then inspect every existing page affected by the source.
README.md - Identify new facts, strengthened or weakened claims, contradictions, connections, and gaps.
- Integrate the findings across all affected pages. Create a source summary or new domain page only when the schema calls for it.
- Add or update relative citations into . Keep conflicting claims and their provenance explicit.
raw/ - Update cross-links and every affected .
README.md - Commit the complete ingest as one change. Record the source, the pages touched, and why the synthesis changed in the commit message.
- Report what changed and any question that needs human direction.
- 读取中的新文件以及架构或Agent指令。不得修改源文件。
raw/ - 阅读,然后检查所有受该源文件影响的现有页面。
README.md - 识别新事实、强化或弱化的声明、矛盾点、关联点和信息缺口。
- 将发现整合到所有受影响的页面中。仅当架构要求时,才创建源文件摘要或新的领域页面。
- 添加或更新指向的相对引用。明确保留冲突声明及其来源。
raw/ - 更新交叉链接和所有受影响的。
README.md - 将完整的导入操作作为单次变更提交。在提交信息中记录源文件、涉及的页面以及内容整合变更的原因。
- 报告变更内容以及任何需要人工指导的问题。
Answer a Query
回答查询
- Read the schema and . Use Git history when recent work or change order matters.
README.md - Follow the index and page links to the relevant maintained synthesis. Consult files in when a claim needs confirmation or the wiki exposes a gap.
raw/ - Answer from the evidence. Cite the supporting wiki pages and underlying raw sources, and state contradictions or missing knowledge directly.
- When the answer creates useful durable analysis, integrate it into the wiki with source citations, update links and every affected , and commit it as one query-driven change. Leave one-off answers in the conversation.
README.md
- 阅读架构和。当近期工作或变更顺序至关重要时,使用Git历史记录。
README.md - 按照索引和页面链接找到相关的整合内容。当声明需要确认或维基存在信息缺口时,查阅中的文件。
raw/ - 基于证据回答问题。引用支持的维基页面和底层源文件,直接说明矛盾点或缺失的知识。
- 当回答产生有用的持久化分析时,将其整合到维基中并添加源文件引用,更新链接和所有受影响的,并将其作为单次查询驱动的变更提交。一次性回答则留在对话中即可。
README.md
Lint the Wiki
检查维基
- Read the schema, , the wiki pages, and relevant Git history.
README.md - Check for:
- contradictions that are hidden or inconsistently represented;
- stale claims superseded by newer evidence;
- missing pages, indexed files that do not exist, and orphaned pages;
- weak, missing, or broken cross-links and source citations;
- important concepts or knowledge gaps that need a page, question, or source;
- pages or directories that need compaction.
- Apply safe bookkeeping fixes and reconcile synthesis when the evidence is clear. Route judgment calls according to the user's review convention.
- Update every affected . If files changed, commit the lint fixes as one change with the findings, fixes, and unresolved gaps in the commit message.
README.md
- 阅读架构、、维基页面和相关Git历史记录。
README.md - 检查以下内容:
- 隐藏或表述不一致的矛盾点;
- 被新证据取代的过时声明;
- 缺失的页面、已索引但不存在的文件,以及孤立页面;
- 薄弱、缺失或失效的交叉链接和源文件引用;
- 需要页面、问题或源文件补充的重要概念或知识缺口;
- 需要压缩的页面或目录。
- 在证据明确的情况下,应用安全的簿记修正并协调整合内容。根据用户的审核规范处理需要判断的问题。
- 更新所有受影响的。如果文件发生变更,将检查修复作为单次变更提交,并在提交信息中记录发现的问题、修复内容和未解决的缺口。
README.md
Compact the Wiki
压缩维基
When pages accumulate stale claims, repeated material, or low-value detail:
- Rewrite decayed pages, merge pages that cover one subject, and delete pages that no longer earn their place.
- Keep the repository flat for the first several dozen pages. When a real topic cluster makes the root hard to scan, move it into a subdirectory with its own ; link that index from the root
README.md.README.md - Fix all affected citations, inbound links, and indexes in the same change.
- Commit the complete compaction as one change. Use Git history to recover anything later.
Suggest compaction when you notice structural debt rather than waiting for the user to find it.
当页面积累了过时声明、重复内容或低价值细节时:
- 重写内容陈旧的页面,合并主题相同的页面,删除不再有存在价值的页面。
- 前几十个页面保持仓库的扁平结构。当真正的主题集群导致根目录难以浏览时,将其移至带有独立的子目录;从根目录
README.md链接到该子目录索引。README.md - 在同一变更中修复所有受影响的引用、入站链接和索引。
- 将完整的压缩操作作为单次变更提交。可通过Git历史记录恢复任何内容。
当发现结构债务时,主动建议进行压缩,而非等待用户发现问题。
Add Tools Proportionally
按需添加工具
Start with Markdown files, file search, relative links, , and Git. Add search engines or embeddings only when navigation no longer works at the wiki's scale. Add image handling only for image-bearing sources. Add presentation formats only when the user needs those outputs. Add metadata or plugins only when they support a real repeated query or workflow. Record adopted tools and conventions in the schema.
README.md从Markdown文件、文件搜索、相对链接、和Git开始。仅当维基规模导致导航失效时,才添加搜索引擎或嵌入功能。仅当源文件包含图片时,才添加图片处理功能。仅当用户需要相关输出时,才添加展示格式。仅当工具支持实际的重复查询或工作流时,才添加元数据或插件。在架构中记录采用的工具和规范。
README.md