Back to Details

workspace-documentation

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Knowledge Capture

知识捕获

Transforms conversations, discussions, and insights into structured documentation in your Notion workspace. Captures knowledge from chat context, formats it appropriately, and saves it to the right location with proper organization and linking.
将对话、讨论和见解转化为Notion工作区中的结构化文档。从聊天语境中捕获知识，进行适当格式化，并通过合理的组织和链接保存到正确的位置。

Quick Start

快速入门

When asked to save information to Notion:
  1. Extract content: Identify key information from conversation context
  2. Structure information: Organize into appropriate documentation format
  3. Determine location: Use 
    Notion:notion-search
    to find appropriate wiki page/database
  4. Create page: Use 
    Notion:notion-create-pages
    to save content
  5. Make discoverable: Link from relevant hub pages, add to databases, or update wiki navigation so others can find it
当被要求将信息保存到Notion时：
  1. 提取内容：从对话语境中识别关键信息
  2. 结构化信息：整理为合适的文档格式
  3. 确定位置：使用
    Notion:notion-search
    查找合适的维基页面/数据库
  4. 创建页面：使用
    Notion:notion-create-pages
    保存内容
  5. 提升可发现性：从相关中心页面添加链接、存入数据库或更新维基导航，以便他人找到内容

Knowledge Capture Workflow

知识捕获工作流

Step 1: Identify content to capture

步骤1：确定要捕获的内容

From conversation context, extract:
- Key concepts and definitions
- Decisions made and rationale
- How-to information and procedures
- Important insights or learnings
- Q&A pairs
- Examples and use cases
从对话语境中提取：
- 关键概念与定义
- 已做出的决策及理由
- 操作指南与流程
- 重要见解或经验总结
- 问答对
- 示例与用例

Step 2: Determine content type

步骤2：确定内容类型

Classify the knowledge:
- Concept/Definition
- How-to Guide
- Decision Record
- FAQ Entry
- Meeting Summary
- Learning/Post-mortem
- Reference Documentation
对知识进行分类：
- 概念/定义
- 操作指南
- 决策记录
- FAQ条目
- 会议总结
- 经验总结/事后复盘
- 参考文档

Step 3: Structure the content

步骤3：结构化内容

Format appropriately based on content type:
- Use templates for consistency
- Add clear headings and sections
- Include examples where helpful
- Add relevant metadata
- Link to related pages
根据内容类型进行适当格式化：
- 使用模板确保一致性
- 添加清晰的标题和章节
- 必要时加入示例
- 添加相关元数据
- 链接到相关页面

Step 4: Determine destination

步骤4：确定存储目标

Where to save:
- Wiki page (general knowledge base)
- Specific project page (project-specific knowledge)
- Documentation database (structured docs)
- FAQ database (questions and answers)
- Decision log (architecture/product decisions)
- Team wiki (team-specific knowledge)
保存位置选择：
- 维基页面（通用知识库）
- 特定项目页面（项目专属知识）
- 文档数据库（结构化文档）
- FAQ数据库（问答内容）
- 决策日志（架构/产品决策）
- 团队维基（团队专属知识）

Step 5: Create the page

步骤5：创建页面

Use Notion:notion-create-pages:
- Set appropriate title
- Use structured content from template
- Set properties if in database
- Add tags/categories
- Link to related pages
使用`Notion:notion-create-pages`：
- 设置合适的标题
- 使用模板生成结构化内容
- 若存入数据库则设置属性
- 添加标签/分类
- 链接到相关页面

Step 6: Make content discoverable

步骤6：提升内容可发现性

Link the new page so others can find it:

1. Update hub/index pages:
   - Add link to wiki table of contents page
   - Add link from relevant project page
   - Add link from category/topic page (e.g., "Engineering Docs")

2. If page is in a database:
   - Set appropriate tags/categories
   - Set status (e.g., "Published")
   - Add to relevant views

3. Optionally update parent page:
   - If saved under a project, add to project's "Documentation" section
   - If in team wiki, ensure it's linked from team homepage

Example:
Notion:notion-update-page
page_id: "team-wiki-homepage-id"
command: "insert_content_after"
selection_with_ellipsis: "## How-To Guides..."
new_str: "- <mention-page url='...'>How to Deploy to Production</mention-page>"
This step ensures the knowledge doesn't become "orphaned" - it's properly connected to your workspace's navigation structure.
为新页面添加链接，方便他人查找：

1. 更新中心/索引页面：
   - 添加链接到维基目录页面
   - 从相关项目页面添加链接
   - 从分类/主题页面添加链接（如“工程文档”）

2. 若页面存入数据库：
   - 设置合适的标签/分类
   - 设置状态（如“已发布”）
   - 添加到相关视图

3. 可选：更新父页面：
   - 若保存到项目下，添加到项目的“文档”章节
   - 若在团队维基中，确保从团队主页可链接到该页面

示例：
Notion:notion-update-page
page_id: "team-wiki-homepage-id"
command: "insert_content_after"
selection_with_ellipsis: "## How-To Guides..."
new_str: "- <mention-page url='...'>How to Deploy to Production</mention-page>"
此步骤可确保知识不会“孤立”——它会被正确关联到工作区的导航结构中。

Content Types

内容类型

Choose appropriate structure based on content:
Concept: Overview → Definition → Characteristics → Examples → Use Cases → Related How-To: Overview → Prerequisites → Steps (numbered) → Verification → Troubleshooting → Related Decision: Context → Decision → Rationale → Options Considered → Consequences → Implementation FAQ: Short Answer → Detailed Explanation → Examples → When to Use → Related Questions Learning: What Happened → What Went Well → What Didn't → Root Causes → Learnings → Actions
根据内容选择合适的结构：
概念：概述 → 定义 → 特征 → 示例 → 用例 → 相关内容 操作指南：概述 → 前置条件 → 步骤（编号）→ 验证 → 故障排除 → 相关内容 决策：背景 → 决策内容 → 理由 → 考虑过的选项 → 影响 → 实施计划 FAQ：简短回答 → 详细解释 → 示例 → 使用场景 → 相关问题 经验总结：事件经过 → 做得好的地方 → 待改进之处 → 根本原因 → 经验教训 → 行动项

Destination Patterns

存储目标模式

General Wiki: Standalone page → add to index → tag → link from related pages
Project Wiki: Child of project page → link from project overview → tag with project name
Documentation Database: Use properties (Title, Type, Category, Tags, Last Updated, Owner)
Decision Log Database: Use properties (Decision, Date, Status, Domain, Deciders, Impact)
FAQ Database: Use properties (Question, Category, Tags, Last Reviewed, Useful Count)
See reference/database-best-practices.md for database selection guide and individual schema files.
通用维基：独立页面 → 添加到索引 → 打标签 → 链接到相关页面
项目维基：项目页面的子页面 → 从项目概述添加链接 → 标记项目名称标签
文档数据库：使用属性（标题、类型、分类、标签、最后更新时间、负责人）
决策日志数据库：使用属性（决策内容、日期、状态、领域、决策者、影响）
FAQ数据库：使用属性（问题、分类、标签、最后审核时间、有用次数）
查看reference/database-best-practices.md获取数据库选择指南和独立模式文件。

Content Extraction from Conversations

从对话中提取内容

Chat Discussion: Key points, conclusions, resources, action items, Q&A
Problem-Solving: Problem statement, approaches tried, solution, why it worked, future considerations
Knowledge Sharing: Concept explained, examples, best practices, common pitfalls, resources
Decision Discussion: Question, options, trade-offs, decision, rationale, next steps
聊天讨论：关键点、结论、资源、行动项、问答内容
问题解决：问题描述、尝试过的方法、解决方案、生效原因、未来注意事项
知识分享：概念讲解、示例、最佳实践、常见陷阱、资源
决策讨论：问题、选项、权衡、决策内容、理由、后续步骤

Formatting Best Practices

格式化最佳实践

Structure: Use 
#
(title), 
##
(sections), 
###
(subsections) consistently
Writing: Start with overview, use bullets, keep paragraphs short, add examples
Linking: Link related pages, mention people, reference resources, create bidirectional links
Metadata: Include date, author, tags, status
Searchability: Clear titles, natural keywords, common search tags, image alt-text
结构：统一使用
#
（标题）、
##
（章节）、
###
（子章节）
写作：以概述开头，使用项目符号，保持段落简短，添加示例
链接：链接到相关页面、提及人员、参考资源、创建双向链接
元数据：包含日期、作者、标签、状态
可搜索性：清晰的标题、自然关键词、常用搜索标签、图片替代文本

Indexing and Organization

索引与组织

Wiki Index: Organize by sections (Getting Started, How-To Guides, Reference, FAQs, Decisions) with page links
Category Pages: Create landing pages with overview, doc links, and recent updates
Tagging Strategy: Use consistent tags for technology/tools, topics, audience, and status
维基索引：按章节（入门指南、操作指南、参考文档、FAQ、决策）组织并添加页面链接
分类页面：创建包含概述、文档链接和最近更新的着陆页
标签策略：为技术/工具、主题、受众和状态使用统一的标签

Update Management

更新管理

Create New: Content is substantive (>2 paragraphs), will be referenced multiple times, part of knowledge base, needs independent discovery
Update Existing: Adding to existing topic, correcting info, expanding concept, updating for changes
Versioning: Add update history section for significant changes (date, author, what changed, why)
创建新内容：内容具有实质性（超过2段）、会被多次引用、属于知识库的一部分、需要独立被发现
更新现有内容：补充现有主题、修正信息、扩展概念、根据变化更新内容
版本控制：为重大变更添加更新历史章节（日期、作者、变更内容、变更原因）

Best Practices

最佳实践

  1. Capture promptly: Document while context is fresh
  2. Structure consistently: Use templates for similar content
  3. Link extensively: Connect related knowledge
  4. Write for discovery: Use searchable titles and tags
  5. Include context: Why this matters, when to use
  6. Add examples: Concrete examples aid understanding
  7. Maintain: Review and update periodically
  8. Get feedback: Ask if documentation is helpful
  1. 及时捕获：在语境清晰时记录文档
  2. 统一结构：为相似内容使用模板
  3. 广泛链接：关联相关知识
  4. 为发现而写：使用清晰的标题和标签
  5. 包含背景：说明重要性和使用场景
  6. 添加示例：具体示例有助于理解
  7. 持续维护：定期审核和更新
  8. 获取反馈：询问文档是否有帮助

Advanced Features

高级功能

Documentation databases: See reference/database-best-practices.md for database schema patterns.
文档数据库：查看reference/database-best-practices.md获取数据库模式示例。

Common Issues

常见问题

"Not sure where to save": Default to general wiki, can move later "Content is fragmentary": Group related fragments into cohesive doc "Already exists": Search first, update existing if appropriate "Too informal": Clean up language while preserving insights
“不确定保存位置”：默认保存到通用维基，之后可再移动 “内容碎片化”：将相关片段整合为连贯的文档 “内容已存在”：先搜索，若合适则更新现有内容 “内容过于随意”：在保留见解的同时优化语言

Examples

示例

See examples/ for complete workflows:
  • examples/conversation-to-faq.md - FAQ from Q&A
  • examples/decision-capture.md - Decision record
  • examples/how-to-guide.md - How-to from discussion
查看examples/获取完整工作流：
  • examples/conversation-to-faq.md - 从问答生成FAQ
  • examples/decision-capture.md - 决策记录
  • examples/how-to-guide.md - 从讨论生成操作指南