GitBook：使用 AI 辅助创建和搜索技术文档的协作平台

GitBook 是一个帮助团队创建、编辑和分享技术文档的在线平台。它支持 Markdown 格式，提供直观的编辑界面，适合技术团队和非技术用户。GitBook 集成了 Git 工作流程，可以与 GitHub 或 GitLab 同步，方便代码与文档协同管理。它还提供 AI 搜索功能，帮助用户快速查找内容。平台支持免费试用，付费计划则提供高级功能，满足企业需求。GitBook 强调简单易用，适合从初创公司到大型企业的各种团队，用于产品文档、API 参考或内部知识库的搭建。

功能列表

• 文档创建与编辑：支持 Markdown 和所见即所得编辑器，创建结构化的技术文档。
• Git 同步：与 GitHub 或 GitLab 双向同步，文档与代码保持一致。
• AI 搜索与洞察：内置 AI 搜索，快速定位文档内容，并提供内容重复或过时的分析。
• 团队协作：支持多人实时编辑、评论和变更请求，促进团队协作。
• 自定义品牌：支持自定义域名、主题和样式，打造品牌化文档。
• 权限管理：提供细粒度的权限控制，适合内部和公开文档。
• 多语言支持：支持国际化翻译，适应全球用户。
• 内容导入：支持从外部平台导入内容，快速迁移现有文档。
• 发布与分享：一键发布文档，支持公开或限制性分享。

使用帮助

GitBook 是一个基于云的文档平台，用户无需安装软件，只需通过浏览器访问即可开始使用。以下是详细的使用指南，帮助用户快速上手。

1. 注册与登录

要使用 GitBook，首先需要创建账户。访问 https://www.gitbook.com/，点击“Start for free”按钮。用户可以选择使用 GitHub、Google 或电子邮件注册。注册后，系统会发送一封验证邮件，点击邮件中的链接完成账户激活。激活后，输入组织名称（个人项目可使用自己的名字），并选择使用场景（如产品文档或内部知识库）。完成设置后，用户将被引导至 GitBook 仪表板。

2. 创建文档空间

在仪表板中，点击“Create a new space”按钮，开始创建文档空间。空间是文档的容器，可用于存储产品手册、API 文档等。用户可以选择模板（如“Book & Manual”）来快速搭建文档结构。输入空间的标题和描述，这些信息会影响搜索引擎的收录效果，因此建议使用清晰、简洁的标题，如“产品 X 使用指南”。

3. 编辑文档

GitBook 提供两种编辑方式：Markdown 和所见即所得（WYSIWYG）编辑器。

• Markdown 编辑：熟练 Markdown 的用户可以直接输入 Markdown 语法。输入 / 调出命令菜单，插入标题、列表、代码块等内容。
• WYSIWYG 编辑器：非技术用户可通过可视化编辑器操作，点击页面空白处添加文本、图片或表格。拖动页面左侧的卡片图标可调整内容顺序。
  要添加新页面，点击左侧栏的“+ Add New Page”按钮，或在现有页面上点击“…”选择“Add New Page”。用户还可以通过“Import”功能从外部平台（如 Notion 或 Confluence）导入内容，方法是点击“Add New Page”并选择“Import Pages”，然后输入链接或上传文件。

4. Git 同步设置

GitBook 的 Git 同步功能是其核心特色，适合习惯代码工作流程的开发团队。

• 连接 Git 仓库：在仪表板中选择空间，点击“Settings” > “Git Sync”，选择 GitHub 或 GitLab 进行授权。授权后，选择要同步的仓库和分支。
• 双向同步：支持从 GitBook 空间同步内容到 Git 仓库，或从 Git 仓库导入内容到 GitBook。每次编辑后，GitBook 会自动生成提交记录，保持文档与代码一致。
• 注意事项：确保 Git 仓库权限正确设置。如果同步时间较长，可检查网络连接或联系 GitBook 支持（support@gitbook.com）。

5. 协作与权限管理

GitBook 支持多人协作。点击空间设置中的“Members”选项，输入队友的邮箱邀请他们加入，并分配角色（如编辑者或查看者）。编辑者可以实时编辑文档，评论或提交变更请求。变更请求需要审核，适合需要严格控制内容的企业团队。权限管理支持细粒度设置，例如限制某些页面仅对特定用户可见。

6. 发布文档

完成编辑后，点击右上角的“Publish”按钮（快捷键：Cmd+S 或 Ctrl+S）。默认情况下，文档为私有，仅团队成员可见。若需公开，点击“Share”按钮，启用“Public”选项，生成公开链接。用户还可设置自定义域名（需付费计划），在“Settings” > “Custom Domain”中配置。发布后，文档自动生成目录和搜索框，方便读者导航。

7. 使用 AI 搜索与洞察

GitBook 的 AI 搜索功能可快速定位内容。用户在文档页面输入关键词，AI 会根据上下文返回相关结果。洞察功能（Insights）可分析文档，提示重复或过时内容。访问“Insights”选项卡，查看系统建议并优化文档。

8. 其他功能

• 多语言支持：在“Settings” > “Internationalization”中启用多语言，添加翻译版本。
• PDF 导出：点击“Export”按钮，将文档导出为 PDF，适合离线分享。
• 键盘快捷键：如 Ctrl+B 加粗，Ctrl+I 斜体，提升编辑效率。

用户可免费试用 GitBook，添加团队成员后根据需求升级付费计划。更多帮助可参考官方文档：https://docs.gitbook.com/。

应用场景

1. 产品文档
   GitBook 适合为软件产品创建用户指南。开发者可以编写安装步骤、使用说明和常见问题解答，结合 Git 同步保持文档与代码一致。
2. API 参考
   技术团队可使用 GitBook 整理 API 文档，添加代码示例和交互式测试用例，方便开发者快速上手。
3. 内部知识库
   企业可构建内部 Wiki，集中存储流程文档、培训材料等，支持权限控制，确保敏感信息安全。
4. 开源项目文档
   开源社区可利用 GitBook 的免费计划发布项目文档，吸引贡献者并简化协作流程。

QA

1. GitBook 是否需要安装软件？
   不需要，GitBook 是基于云的平台，通过浏览器访问即可使用。
2. 免费计划有哪些限制？
   免费计划适合个人或小团队，支持基本文档功能，但高级功能如自定义域名和高级权限需付费计划。
3. 如何与 GitHub 同步？
   在空间设置中启用 Git Sync，授权 GitHub 账户，选择仓库和分支即可实现双向同步。
4. 是否支持非技术用户？
   是的，GitBook 提供直观的 WYSIWYG 编辑器，非技术用户无需学习 Markdown 即可编辑文档。
5. 如何联系支持团队？
   通过 support@gitbook.com 或官网的“Contact Us”页面联系支持团队。