关于 workspace-documentation
workspace-documentation 是一项将对话和见解整理为 Notion 工作区文档的技能。它按内容类型与存放位置组织信息,并通过添加链接让新页面易于查找。
主要功能
- 01从对话中提取知识
- 02按文档类型整理内容
- 03用 Notion 搜索确定存放位置
- 04在 Notion 中创建页面
- 05将页面链接到工作区导航
适用场景
- 01将会议讨论保存为文档
- 02在决策日志中记录决策
- 03把问答整理为 FAQ 条目
- 04在 Notion 中组织项目知识
MCP 相关
该技能使用 Notion 工具(包括 notion-search 和 notion-create-pages)查找存放位置并创建页面,也会将新内容链接到相关工作区页面和数据库。
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ qodex-ai/ ai-agent-skills --skill workspace-documentation安装后在 Claude Code 中输入/workspace-documentation确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
evaluations/conversation-to-wiki.jsondecision-record.jsonREADME.mdexamples/conversation-to-faq.mddecision-capture.mdhow-to-guide.mdreference/database-best-practices.mddecision-log-database.mddocumentation-database.mdfaq-database.mdhow-to-guide-database.mdlearning-database.mdteam-wiki-database.md详细介绍
知识捕获
将对话、讨论和见解转化为 Notion 工作区中的结构化文档。从聊天上下文中捕获知识,按适当格式整理,并妥善组织、添加链接后保存到正确位置。
快速入门
有人要求将信息保存到 Notion 时:
- 提取内容:从对话上下文中识别关键信息
- 整理信息:按适当的文档格式组织内容
- 确定位置:使用
Notion:notion-search查找合适的维基页面或数据库 - 创建页面:使用
Notion:notion-create-pages保存内容 - 便于查找:从相关中心页面添加链接、将内容添加到数据库,或更新维基导航,让其他人也能找到
知识捕获工作流
步骤 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
步骤 2:确定内容类型
Classify the knowledge:
- Concept/Definition
- How-to Guide
- Decision Record
- FAQ Entry
- Meeting Summary
- Learning/Post-mortem
- Reference Documentation
步骤 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
步骤 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)
步骤 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
步骤 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>"
此步骤可确保知识不会成为“孤立内容”,而是与工作区的导航结构妥善关联。
内容类型
根据内容选择合适的结构:
概念:概述 → 定义 → 特征 → 示例 → 使用场景 → 相关内容 操作指南:概述 → 前提条件 → 步骤(编号)→ 验证 → 故障排除 → 相关内容 决策:背景 → 决策 → 理由 → 考虑过的选项 → 后果 → 实施 常见问题:简短回答 → 详细说明 → 示例 → 适用场景 → 相关问题 学习总结:发生了什么 → 哪些进展顺利 → 哪些不顺利 → 根本原因 → 经验总结 → 行动
目标位置模式
通用维基:独立页面 → 添加到索引 → 添加标签 → 从相关页面添加链接
项目维基:作为项目页面的子页面 → 从项目概述添加链接 → 添加项目名称标签
文档数据库:使用属性(标题、类型、类别、标签、上次更新、负责人)
决策日志数据库:使用属性(决策、日期、状态、领域、决策者、影响)
常见问题数据库:使用属性(问题、类别、标签、上次审核、有用次数)
有关数据库选择指南和各数据库的架构文件,请参阅 reference/database-best-practices.md。
从对话中提取内容
聊天讨论:要点、结论、资源、待办事项、问答
问题解决:问题陈述、尝试过的方法、解决方案、奏效的原因、后续考虑事项
知识分享:概念说明、示例、最佳实践、常见陷阱、资源
决策讨论:问题、选项、权衡、决策、理由、后续步骤
格式设置最佳实践
结构:始终一致地使用 #(标题)、##(章节)、###(小节)
写作:从概述开始,使用项目符号,保持段落简短,并添加示例
链接:链接相关页面,提及相关人员,引用资源,并创建双向链接
元数据:包含日期、作者、标签、状态
可搜索性:标题清晰,使用自然关键词和常见搜索标签,并添加图片替代文本
索引与组织
维基索引:按章节组织(入门、操作指南、参考资料、常见问题、决策),并添加页面链接
分类页面:创建包含概述、文档链接和近期更新的入口页面
标签策略:为技术/工具、主题、受众和状态使用一致的标签
更新管理
新建:内容丰富(超过 2 个段落)、会被多次引用、属于知识库的一部分,或需要独立查找
更新现有内容:补充现有主题、纠正信息、扩展概念或根据变化进行更新
版本管理:重大变更时添加更新历史章节(日期、作者、变更内容、原因)
最佳实践
- 及时记录:趁记忆犹新时整理文档
- 保持结构一致:为类似内容使用模板
- 广泛添加链接:关联相关知识
- 便于查找:使用便于搜索的标题和标签
- 补充背景:说明其重要性以及适用场景
- 添加示例:具体示例有助于理解
- 持续维护:定期审阅和更新
- 征求反馈:询问文档是否有帮助
高级功能
文档数据库:数据库架构模式请参阅 reference/database-best-practices.md。
常见问题
“不确定保存到哪里”:默认保存到通用 Wiki,之后可以移动 “内容零散”:将相关片段整理成连贯的文档 “内容已存在”:先搜索,合适时更新现有内容 “语气太随意”:在保留见解的同时润色措辞
示例
完整工作流请参阅 examples/:
- examples/conversation-to-faq.md - 根据问答整理 FAQ
- examples/decision-capture.md - 决策记录
- examples/how-to-guide.md - 根据讨论编写操作指南