词汇表
术语表:建设中 🚧
我们的术语表仍在持续完善中,我们会不断添加新的定义。敬请期待更多内容!
A
插件
可集成到 Archbee 中以增强其功能的附加特性或模块,例如用于高级 AI 功能的 AI Addon。
API 端点
清晰记录您的 API endpoints,为开发者和用户提供必要的详细信息。
B
区块
构建文档的基础模块。可将它们视为构建内容的乐高积木。您可以使用它们创建标题、表格、图像、代码片段等。可选择基础、媒体、开发者和嵌入式等类型。
按钮
交互式按钮,可链接到其他内部或外部页面,引导用户浏览文档或文档之外的内容。
C
Callout
使用视觉上突出的提示框来强调重要的说明、提示或警告,以吸引用户注意关键信息。
更新日志块
使用 changelog 模块记录项目更新和更改,让用户随时了解最新动态。
代码编辑器
用于展示代码片段的多语言代码编辑器,非常适合开发人员使用。
代码抽屉
将代码片段组织在抽屉中,并与内容并排显示,使文档保持整洁且用户友好。
内容片段
创建可在多个文档中重复使用的内容块,确保一致性并节省时间。
D
E
编辑器
这是您创建和编辑内容的首选位置。它就像一个数字工作区,您可以使用快捷方式、添加不同类型的内容块,并通过 Markdown 或 WYSIWYG 菜单来格式化文本。您甚至可以嵌入来自其他工具的内容并链接到其他文档。可以将其视为满足所有内容创建需求的一站式平台!
嵌入式块
将来自 Loom、Figma 和 Miro 等常用工具的内容直接集成到您的文档中,带来一致的体验。
可展开标题
可展开或折叠的章节,使您能够轻松浏览复杂主题。
F
文件
在文档中直接上传和链接文件,使资源对用户来说易于访问。
文件管理器
在一个中心位置组织和管理所有文件,使您能够轻松上传、访问和链接文档中的资源。
G
GraphQL
有效编写 GraphQL APIs 文档,为用户提供与您的服务交互所需的信息。
H
标题
用于创建标题和副标题,以按层级结构组织内容。
水平分隔线
水平分割线可帮助您在章节之间创建视觉间隔,从而提升文档的阅读流畅性。
I
图像
通过图片丰富您的文档,为内容添加视觉上下文并增强参与度。
J
K
L
链接网格
创建指向其他文档或外部资源的动态链接,便于在内容中轻松导航。
Lists
使用有序和无序列表将信息分解为易于理解的要点,提高可读性。
M
Map
集成地图以显示基于位置的信息,从而增强内容的相关性。
使用 Mermaid 语法创建流程图和图表,为文档添加视觉辅助。
使用 Minitaskers 将任务组织为可管理的子任务,以保持项目按计划推进,其灵感来自 Trello。
N
O
P
Q
R
可复用组件
创建和管理可插入多个文档的可复用内容块,从而确保一致性并节省编写文档的时间。
S
Spaces
用于按团队或项目组织文档的容器。每个账户都有一个个人空间,组织可以创建具有访问控制的自定义空间。
空间群
可以将它们视为空间的文件夹。系统开始时会提供一个名为“Spaces”的文件夹。根据需要创建更多文件夹。您可以添加、重命名或删除文件夹(但仅当文件夹为空时)。要将空间放入文件夹,只需将其拖动到目标位置、使用移动操作或直接在该文件夹中创建它。
空间链接
连接多个已发布的空间,便于文档之间的导航(例如用户指南、API 文档)。在空间设置中添加链接、设置标签并发布。链接的更改会自动在所有连接的空间中更新。
无缝集成 OpenAPI 规范,以增强您的 API 文档。
T
表格
使用表格区块以清晰、有条理的方式呈现数据,非常适用于比较和结构化信息。
Tabs
将内容组织进多个标签页,以实现简洁高效的导航体验,使用户能够轻松切换不同主题。
TeX 方程
使用 TeX 渲染复杂的数学方程,使您的文档适用于技术主题。
U
用户组
类似于用户的部门。您可以创建不同的组(如 Engineers、Marketing 或 Management)并将用户分配给它们。这有助于组织用户,并为其分配对组织不同部分的不同访问级别。
V
垂直拆分
使用纵向分栏区块并排展示内容,非常适用于比较或展示相关信息。
W
Workflow
使用此区块可可视化流程和工作流,帮助用户清晰理解步骤和顺序。
所见即所得菜单
一个用户友好的 "What You See Is What You Get" 菜单,使您能够以可视方式格式化内容,使文档创建直观且简单。
X
Y
Z
以下是 Archbee 中可用的其他品牌功能列表,并附有描述:
Archbee Reusables
- 可重复使用物品:创建和管理可重复使用的内容块,可将其插入多个文档中,从而确保一致性并节省文档编写时间。
Archbee File Manager
- 文件管理器:在一个中心位置组织和管理所有文件,使上传、访问和链接文档资源变得更加容易。
Archbee Markdown
- Markdown:使用 Markdown 语法快速高效地格式化文本,使写作体验更加流畅,同时保持文档设计的灵活性。
Archbee WYSIWYG Menu
- 所见即所得菜单:体验一个用户友好的“所见即所得”编辑器,使您能够以可视化方式格式化内容,让文档创建变得直观且简单。
Archbee Emojis
- 表情符号:使用 emojis 增强文档的可读性与视觉吸引力,让内容更具表现力并贴近用户。
Archbee Drag & Drop
- 拖放:通过简单的拖放界面轻松重新排列文档中的区块和内容,使调整与组织更加高效。
Archbee Variables
- 变量:使用 variables 插入可根据上下文变化的动态内容,使文档能够适应不同用户并实现个性化。
Archbee Space-Specific Variables
- 空间特定变量:定义特定空间专属的 variables,使内容能够根据不同项目或团队需求进行定制。
Archbee Glossary
- 术语表:创建术语表,为专业词汇提供定义和解释,从而提升用户理解度与文档可访问性。
Archbee Docs Tagging
- 文档标签:使用标签组织文档,以便于分类和检索,提高文档的导航性与搜索效率。
Archbee Display Rules
- 显示规则:根据用户角色或其他条件设置显示内容的规则,实现内容的显示或隐藏,以提供个性化的用户体验。
Archbee Find & Replace
- 查找和替换:快速查找并替换文档中的文本,简化编辑流程并确保内容一致性。
Archbee Notifications
- 通知:通过实时通知了解文档的更新、评论和更改,使您能够随时掌握团队动态。
Archbee Notification Center
- 通知中心:访问集中管理所有通知的中心位置,使您能够高效管理与查看更新内容。
Archbee Comments
- 评论:通过在文档中直接添加评论与团队协作,便于围绕特定内容展开讨论与反馈。
Archbee Templates
- 模板:使用预先设计的模板来快速启动文档项目,确保内容的一致外观和结构。
Archbee Category
- 类别: 将您的文档组织到不同类别中,以获得更好的结构和更轻松的导航,从而帮助用户快速找到相关信息。
Archbee Document History
- 文档历史: 跟踪文档随时间所做的更改和修订,必要时允许您恢复到以前的版本。
Archbee Review System
- 评论系统: 为您的文档实施结构化的审核流程,确保在发布前的质量和准确性。
Archbee Verify Documents
- 验证文件: 通过根据既定标准或指南验证内容,确保文档的完整性和准确性。
Archbee Hidden Docs
- 隐藏文档: 将某些文档保持私密或对用户隐藏,同时仍允许其被索引用于搜索目的,以保持机密性。
这些功能使您能够有效地创建、管理和协作处理文档,从而提升在 Archbee 中的整体用户体验。