附录
常见问题解答、快捷键参考和术语表,帮助你更好地使用 MeshWork。
A. 常见问题
私有内容会意外共享吗?
不会。MeshWork 通过明确的数据边界设计来保护你的私有内容:
- 物理隔离:私有知识库和共享空间在文件系统中是完全独立的目录。私有知识库的内容不会自动出现在任何共享空间中。
- Git 独立:即使启用了 Git 版本控制,私有知识库和共享空间也使用各自独立的 Git 仓库或分支。私有知识库的提交不会推送到共享空间的远程仓库。
- 显式操作:只有当你主动将内容从私有知识库复制或移动到共享空间时,内容才会进入共享边界。AI 助手不会自动执行这类操作。
- 权限控制:共享空间的远程仓库访问权限由 Git 托管平台(如 GitHub)管理。只有被授权的团队成员才能访问共享空间的内容。
在团队协作时,建议将个人笔记、草稿和未公开的想法保存在私有知识库中。只有经过整理、适合团队共享的内容再发布到共享空间。
如何处理 Git 冲突?
Git 冲突通常发生在多人同时修改同一文档的不同版本时。当 MeshWork 无法自动合并更改时,会弹出冲突解决界面:
- 识别冲突:系统会自动检测到冲突文件,并打开冲突解决界面。
- 查看差异:界面左侧列出所有冲突文件。选中文件后,主区域会并排显示本地版本和远程版本的内容,方便你对比差异。
- 选择解决方案:对于每个冲突文件,点击下方的按钮选择保留方式:
- 保留本地版本:保留你本地修改的内容,丢弃远程版本。
- 使用远程版本:采用远程版本的内容,放弃本地修改。
- 两者都保留(本地优先):合并两个版本,本地版本的内容排在前面。
- 两者都保留(远程优先):合并两个版本,远程版本的内容排在前面。
- 预览结果:选择后,界面右侧会显示合并后的最终版本预览,你可以确认结果是否符合预期。
- 应用解决:确认无误后点击"应用",系统会将解决后的内容写入文档并标记冲突已解决。
频繁拉取最新更改、及时推送本地修改、保持文档粒度适当,都可以减少冲突的发生。在大型团队中,建议通过讨论协调,避免多人同时修改同一文档的同一部分。
AI 助手消耗如何控制?
MeshWork 提供了多层控制机制来管理 AI 助手的消耗:
- 工具调用次数限制:在"设置 → 文档"和"设置 → 讨论"中,可以分别设置文档助手或讨论区单次回复最多调用工具的次数。
- 自动会话时长:在"设置 → 讨论"中设置默认自动会话时长(默认 2 分钟)。共享空间和讨论区话题可以单独覆盖,留空时继承上一级配置。
- 模型选择:不同模型的定价和性能不同。对于简单任务,可以选择成本较低的模型;对于复杂推理,可以选择更强大的模型。
- 使用监控:定期查看 AI 服务的使用统计和账单,了解消耗趋势并调整使用策略。
API Key 存储在本地,请确保不会泄露。如果你将 MeshWork 配置文件或设备分享给他人,请先移除其中的 API Key。
多设备使用注意事项
在多台设备上使用 MeshWork 时,请注意以下事项:
- 数据同步:MeshWork 本身不提供设备间的数据同步服务。你需要通过 Git 远程仓库或其他同步机制(如 iCloud Drive、Dropbox)来同步数据。
- Git 配置:每台设备都需要配置可访问远端仓库的认证方式。SSH 方式请选择私钥文件或粘贴私钥内容;HTTPS 方式使用访问令牌。
- SSH 密钥:如果使用 SSH 方式访问远程仓库,每台设备都需要生成并添加自己的 SSH 密钥到 GitHub。
- API Key:AI 服务的 API Key 需要在每台设备上单独配置。请注意安全,不要在设备间不安全地传输 API Key。
- 工作台配置:工作台配置(如添加的共享空间列表)存储在本地,需要手动在每台设备上配置。
- 同时编辑:避免在两台设备上同时编辑同一文档且不频繁同步,这容易导致 Git 冲突。
在多设备使用时,养成开始工作前先拉取最新更改、结束工作后及时推送的习惯。这样可以减少冲突,确保各设备上的数据保持一致。
如何备份数据?
MeshWork 采用 local-first 设计,你的所有数据都存储在本地磁盘上。以下是几种备份方式:
- Git 远程仓库:为私有知识库和共享空间配置 Git 远程仓库(如 GitHub)。这是最简单可靠的备份方式,同时提供版本历史。
- 时间机器(macOS):使用 macOS 自带的时间机器功能备份整个磁盘,包括 MeshWork 的数据目录。
- 云存储同步:将 MeshWork 的工作目录放在 iCloud Drive、Dropbox、OneDrive 等云存储服务的同步文件夹中。注意:这可能增加 Git 冲突的风险,请谨慎使用。
- 手动复制:定期手动将 MeshWork 的工作目录复制到外部存储设备或其他位置。
推荐使用 Git 远程仓库作为主要备份方式,因为它同时提供了版本控制、协作共享和历史恢复能力。对于特别重要的内容,可以结合时间机器进行双重保护。
B. 快捷键参考
以下列出的是 MeshWork 当前已实现的快捷键。产品仍在持续开发中,更多快捷键将在后续版本中添加。
界面操作快捷键
MeshWork 提供以下界面操作的快捷键:
| 快捷键 | 功能 |
|---|---|
⌘ ⌥ S |
切换侧边栏显示/隐藏 |
⌘ ⌥ 0 |
切换 AI 助手面板显示/隐藏 |
⌘ F |
聚焦工作台左侧搜索框 |
⌘ S |
按当前编辑器状态保存文档 |
⌘ E |
切换编辑器预览 |
⌘ ⌥ E |
切换编辑器模式(源代码/所见即所得) |
文本编辑快捷键
在文档编辑器中,MeshWork 支持以下文本格式化快捷键:
| 快捷键 | 功能 |
|---|---|
⌘ B |
切换粗体格式 |
⌘ I |
切换斜体格式 |
字号和缩放快捷键
MeshWork 支持焦点感知的字号和缩放调整:
| 快捷键 | 功能 |
|---|---|
⌘ = 或 ⌘ + |
增加字号(编辑器焦点)或缩放(预览焦点) |
⌘ - |
减小字号(编辑器焦点)或缩放(预览焦点) |
⌘ 0 |
重置字号(编辑器焦点)或缩放(预览焦点) |
字号和缩放快捷键会根据当前焦点区域自动调整:当编辑器有焦点时调整编辑器字号,当预览区域有焦点时调整预览缩放。
AI 对话快捷键
在 AI 助手面板中,可以使用以下快捷键和符号:
| 快捷键/符号 | 功能 |
|---|---|
@(在输入框中) |
触发智能体选择 |
#(在输入框中) |
触发文档引用 |
/(在输入框中) |
触发自定义命令 |
↩(Enter) |
发送消息 |
⇧ ⌘ ↩ |
强制开始新的 AI 会话(忽略自动会话) |
MeshWork 遵循 macOS 标准文本编辑快捷键,如 ⌘ C(复制)、⌘ V(粘贴)、⌘ Z(撤销)等,这些快捷键在应用中均正常工作。
C. 术语表
- 工作台(Workspace)
- MeshWork 的主使用环境,是一个产品和交互层概念,不是固定磁盘目录或 Git 仓库。工作台负责组合一个私有知识库和多个共享空间,提供统一的访问入口。
- 私有知识库(Private Library)
- 属于当前用户自己的数据边界,适合存放个人长期笔记、研究资料、写作草稿、灵感片段和不应自动进入团队共享的内容。它独立存在,不从属于任何共享空间。
- 共享空间(Shared Space)
- 团队或项目级的数据边界,包含公共知识库、讨论区、共享附件,并可选拥有自己的 Git 历史。多个用户可以通过共享空间进行协作。
- 公共知识库(Public Library)
- 共享空间中用于存放长期知识的部分,适合存放团队成员共同维护的文档、项目资料、决策记录等。公共知识库中的内容会自动同步给所有该空间的成员。
- 讨论区(Discussion Area)
- 共享空间中用于日常对话和临时沟通的部分。讨论区中的内容是对话式的,适合快速交流、头脑风暴和即时反馈。
- 智能体(Agent)
- 配置了特定提示词和参数的 AI 助手。MeshWork 支持多个智能体,每个智能体可以有不同的专长和行为模式。在对话中可以通过 @ 符号选择特定的智能体。
- 自动会话窗口(Auto Session Window)
- 在发送消息给 AI 智能体后的一段时间内(默认 2 分钟),继续发送的消息会自动发送给同一个智能体,无需重复 @。这个时间窗口称为自动会话窗口。
- Topic
- 讨论区中的对话线程。每个 Topic 有一个主题和一组相关的消息。Topic 可以帮助组织讨论内容,避免重要信息被淹没在大量消息中。
- Topic Knowledge Card
- 讨论区单个话题对应的一张结构化知识卡,用于记录当前已经形成的总结、关键点、决定、未决问题和下一步行动。它与原始消息流并存,并通过 Git 历史保留这张卡片如何随讨论演化。
- 分支隔离(Branch Isolation)
- MeshWork 使用 Git 分支来隔离不同知识库的数据。即使多个知识库使用同一个远端仓库,它们也会绑定到不同的分支,互不干扰。这允许在同一个远程仓库中安全地存储多个相关但独立的知识库。
- 资源目录(Resource Directory)
- 私有知识库或共享空间在磁盘上的实际存储位置。资源目录包含文档、讨论、附件等所有数据文件。
- Git 提交(Commit)
- Git 版本控制中的一个保存点,记录了文件在某一时刻的状态。MeshWork 会在适当的时机自动创建提交,你也可以手动创建提交来保存重要状态。
- Git 推送(Push)
- 将本地的 Git 提交上传到远程仓库的操作。推送后,其他团队成员才能看到你的修改。
- Git 拉取(Pull)
- 从远程仓库获取最新更改并合并到本地的操作。拉取可以让你看到其他团队成员的最新修改。
- Git 冲突(Conflict)
- 当 Git 无法自动合并两处修改时发生的状况。冲突需要手动解决,选择保留哪些内容。
- API Key
- 用于访问 AI 服务(如 OpenAI、Anthropic Claude)的密钥。你需要在 MeshWork 中配置 API Key 才能使用 AI 助手功能。
- AI Provider
- AI 服务提供商,如 OpenAI、Anthropic、Google 等。MeshWork 支持多个提供商,你可以根据需要选择。
- 自定义命令(Custom Command)
- 在文档编辑器中可以通过 / 符号触发的快捷指令。你可以自定义命令来实现常用功能,如总结文档、提取待办事项等。
- Markdown
- 一种轻量级标记语言,使用简单的文本格式来表示富文本格式。MeshWork 使用 Markdown 作为文档的默认格式。
- PlantUML
- 一种用文本描述图表的标记语言,常用于时序图、组件图和技术架构说明。MeshWork 可以在 Markdown 预览和所见即所得编辑中渲染
plantuml与puml代码块。完整语法见 PlantUML 官方网站。 - 本地优先(Local-first)
- 一种软件架构理念,强调数据主要存储在本地设备上,云端服务作为辅助和备份。MeshWork 采用本地优先设计,确保你在离线时也能正常使用。