Glossary
Glossary: Under Construction 🚧
Our glossary is a work in progress, but we're adding new definitions all the time. Stay tuned for more!
A
Addon
An additional feature or module that can be integrated into Archbee to enhance its capabilities, such as the AI Addon for advanced AI functionalities.
Document your API endpoints with clarity, providing essential details for developers and users alike.
B
Blocks
Building blocks for your docs. Think of them as Legos for your content. You can use them to create headings, tables, images, code snippets, and more. There are basic, media, developer, and embedded blocks to choose from.
Button
Interactive buttons that link to other internal or external pages, guiding users through your documentation or your content outside the documentation.
C
Callout
Highlight important notes, tips, or warnings with visually distinct callouts to draw attention to key information.
Keep your users informed with a changelog block that documents updates and changes in your project.
A multi-language code editor for showcasing code snippets, perfect for developers.
Organize your code snippets in drawers and show them side-by-side with your conent, keeping your documentation tidy and user-friendly.
Create reusable blocks of content that can be inserted across multiple documents, ensuring consistency and saving time.
D
E
Editor
Your go-to place for creating and editing content. It's like a digital workspace where you can use shortcuts, add different types of content blocks, and format your text using Markdown or the WYSIWYG menu. You can even embed content from other tools and link to other documents. Think of it as your one-stop shop for all things content creation!
Integrate content from popular tools like Loom, Figma, and Miro directly into your documentation for a cohesive experience.
Sections that can be expanded or collapsed, making it easy to navigate complex topics.
F
File
Upload and link files directly within your documentation, making resources easily accessible to users.
Organize and manage all your files in one central location, making it easy to upload, access, and link resources within your documentation.
G
GraphQL
Document GraphQL APIs effectively, providing users with the information they need to interact with your services.
H
Headings
Used to create titles and subtitles for organizing content hierarchically.
Horizontal dividers helps you to create visual breaks between sections, enhancing the flow of your documentation.
I
Image
Enrich your documentation with images, adding visual context and engagement to your content
J
K
L
Create dynamic links to other documents or external resources, facilitating easy navigation within your content.
Lists
Utilize ordered and unordered lists to break down information into digestible points, improving readability.
M
Map
Integrate maps to display location-based information, enhancing the relevance of your content.
Create flowcharts and diagrams using the Mermaid syntax, adding visual aids to your documentation.
Organize tasks into manageable subtasks with Minitaskers, inspired by Trello, to keep your projects on track.
N
O
P
Q
R
Reusables
Create and manage reusable content blocks that can be inserted into multiple documents, ensuring consistency and saving time across your documentation.
S
Spaces
Containers for documents organized by teams or projects. Each account has a personal space, and organizations can create custom ones with access control.
Think of them as folders for your Spaces. You start with one called "Spaces." Make more folders if you need them. You can add, rename, or delete folders (but only if they're empty). To put a Space in a folder, just drag it there, use the move action, or create it in the folder.
Connect multiple published Spaces for easy navigation between docs (e.g., User Guides, API docs). Add links in Space settings, label them, and publish. Changes to links automatically update across connected Spaces.
Seamlessly integrate OpenAPI specifications to enhance your API documentation.
T
Table
Use table block to present data in a clear and organized manner, perfect for comparisons and structured information.
Tabs
Organize content into multiple tabs for a clean and efficient navigation experience, allowing users to switch between topics easily.
Render complex mathematical equations using TeX, making your documentation suitable for technical subjects.
U
User Groups
Are like departments for your users. You can create different groups (like Engineers, Marketing, or Management) and assign users to them. This helps you organize your users and give them different access levels to different parts of your organization.
V
Showcase content side-by-side with the vertical split block, ideal for comparisons or related information.
Video
W
Workflow
Visualize processes and workflows with this block, helping users understand steps and sequences clearly.
A user-friendly "What You See Is What You Get" menu that allows you to format your content visually, making document creation intuitive and straightforward.
X
Y
Z
Here’s a branded list of additional features available in Archbee, complete with descriptions:
Archbee Reusables
- Reusables: Create and manage reusable content blocks that can be inserted into multiple documents, ensuring consistency and saving time across your documentation.
Archbee File Manager
- File Manager: Organize and manage all your files in one central location, making it easy to upload, access, and link resources within your documentation.
Archbee Markdown
- Markdown: Utilize Markdown syntax to format your text quickly and efficiently, allowing for a streamlined writing experience while maintaining flexibility in document design.
Archbee WYSIWYG Menu
- WYSIWYG Menu: Experience a user-friendly "What You See Is What You Get" editor that allows you to format your content visually, making document creation intuitive and straightforward.
Archbee Emojis
- Emojis: Enhance your documentation with emojis to add personality and visual interest, making your content more engaging and relatable to users.
Archbee Drag & Drop
- Drag & Drop: Easily rearrange blocks and content within your documents using a simple drag-and-drop interface, allowing for quick adjustments and organization.
Archbee Variables
- Variables: Use variables to insert dynamic content that can change based on context, making your documentation adaptable and personalized for different users.
Archbee Space-Specific Variables
- Space-Specific Variables: Define variables that are unique to specific spaces, allowing for tailored content that meets the needs of different projects or teams.
Archbee Glossary
- Glossary: Create a glossary of terms to provide definitions and explanations for specialized vocabulary, enhancing user understanding and accessibility.
Archbee Docs Tagging
- Docs Tagging: Organize your documents with tags for easy categorization and retrieval, improving navigation and searchability within your documentation.
Archbee Display Rules
- Display Rules: Set conditions for when specific content should be shown or hidden based on user roles or other criteria, allowing for a customized user experience.
Archbee Find & Replace
- Find & Replace: Quickly locate and replace text throughout your documentation, streamlining the editing process and ensuring consistency.
Archbee Notifications
- Notifications: Stay informed with real-time notifications about updates, comments, and changes in your documentation, keeping you connected to your team.
Archbee Notification Center
- Notification Center: Access a centralized hub for all your notifications, allowing you to manage and review updates efficiently.
Archbee Comments
- Comments: Collaborate with your team by adding comments directly within documents, facilitating discussions and feedback on specific content.
Archbee Templates
- Templates: Utilize pre-designed templates to kickstart your documentation projects, ensuring a consistent look and feel across your content.
Archbee Category
- Category: Organize your documents into categories for better structure and easier navigation, helping users find relevant information quickly.
Archbee Document History
- Document History: Track changes and revisions made to your documents over time, allowing you to revert to previous versions if needed.
Archbee Review System
- Review System: Implement a structured review process for your documents, ensuring quality and accuracy before publication.
Archbee Verify Documents
- Verify Documents: Ensure the integrity and accuracy of your documentation by verifying content against established standards or guidelines.
Archbee Hidden Docs
- Hidden Docs: Keep certain documents private or hidden from users while still allowing them to be indexed for search purposes, maintaining confidentiality.
These features empower you to create, manage, and collaborate on documentation effectively, enhancing the overall user experience within Archbee.