Glosario

Una funcionalidad o módulo adicional que puede integrarse en Archbee para mejorar sus capacidades, como el AI Addon para funcionalidades avanzadas de IA.

Documente sus API endpoints con claridad, proporcionando detalles esenciales tanto para desarrolladores como para usuarios.

Bloques de construcción para su documentación. Piénselos como Legos para su contenido. Puede usarlos para crear encabezados, tablas, imágenes, fragmentos de código y más. Hay bloques básicos, de medios, para desarrolladores y embebidos entre los que puede elegir.

Botones interactivos que enlazan a otras páginas internas o externas, guiando a los usuarios a través de su documentación o de su contenido fuera de la documentación.

Resalte notas importantes, consejos o advertencias con callouts visualmente distintivos para llamar la atención sobre información clave.

Mantenga a sus usuarios informados con un bloque de changelog que documenta actualizaciones y cambios en su proyecto.

Un editor de código multi-idioma para mostrar fragmentos de código, perfecto para desarrolladores.

Organice sus fragmentos de código en cajones y muéstrelos junto con su contenido, manteniendo su documentación ordenada y fácil de usar.

Cree bloques reutilizables de contenido que pueden insertarse en múltiples documentos, garantizando consistencia y ahorrando tiempo.

Su lugar de referencia para crear y editar contenido. Es como un espacio de trabajo digital donde usted puede usar atajos, agregar diferentes tipos de bloques de contenido y formatear su texto usando Markdown o el menú WYSIWYG. Incluso puede incrustar contenido de otras herramientas y enlazar con otros documentos. Piénselo como su centro único para todo lo relacionado con la creación de contenido.

Integre contenido de herramientas populares como Loom, Figma y Miro directamente en su documentación para una experiencia coherente.

Secciones que pueden expandirse o contraerse, lo que facilita la navegación por temas complejos.

Cargue y enlace archivos directamente dentro de su documentación, haciendo que los recursos sean fácilmente accesibles para los usuarios.

Organice y gestione todos sus archivos en una ubicación central, lo que facilita cargar, acceder y enlazar recursos dentro de su documentación.

Documente APIs GraphQL de forma efectiva, proporcionando a los usuarios la información que necesitan para interactuar con sus servicios.

Se usan para crear títulos y subtítulos para organizar el contenido de manera jerárquica.

Los divisores horizontales le ayudan a crear separaciones visuales entre secciones, mejorando el flujo de su documentación.

Enriquezca su documentación con imágenes, agregando contexto visual y mayor interacción con su contenido

Cree enlaces dinámicos a otros documentos o recursos externos, lo que facilita la navegación dentro de su contenido.

Utilice listas ordenadas y desordenadas para desglosar la información en puntos digeribles, mejorando la legibilidad.

Integre mapas para mostrar información basada en ubicaciones, mejorando la relevancia de su contenido.

Cree diagramas y diagramas de flujo utilizando la sintaxis de Mermaid, agregando elementos visuales a su documentación.

Organice tareas en subtareas manejables con Minitaskers, inspirado en Trello, para mantener sus proyectos encaminados.

Cree y gestione bloques de contenido reutilizables que pueden insertarse en múltiples documentos, garantizando coherencia y ahorrando tiempo en toda su documentación.

Contenedores para documentos organizados por equipos o proyectos. Cada cuenta tiene un espacio personal y las organizaciones pueden crear espacios personalizados con control de acceso.

Piense en ellos como carpetas para sus Espacios. Comienza con una llamada "Espacios". Cree más carpetas si es necesario. Puede agregar, renombrar o eliminar carpetas (pero solo si están vacías). Para colocar un Espacio en una carpeta, simplemente arrástrelo allí, utilice la acción de mover o créelo directamente en la carpeta.

Conecte múltiples Espacios publicados para facilitar la navegación entre documentos (por ejemplo, Guías de Usuario, API docs). Agregue enlaces en las configuraciones del Espacio, etiquételos y publíquelos. Los cambios en los enlaces se actualizan automáticamente en todos los Espacios conectados.

Integre sin problemas las especificaciones OpenAPI para mejorar su documentación de API.

Utilice el bloque de tabla para presentar datos de manera clara y organizada, ideal para comparaciones e información estructurada.

Organice contenido en múltiples pestañas para una experiencia de navegación limpia y eficiente, permitiendo a los usuarios cambiar fácilmente entre temas.

Renderice ecuaciones matemáticas complejas usando TeX, haciendo que su documentación sea adecuada para temas técnicos.

Funcionan como departamentos para sus usuarios. Puede crear diferentes grupos (como Engineers, Marketing o Management) y asignar usuarios a ellos. Esto le ayuda a organizar a sus usuarios y darles diferentes niveles de acceso a distintas partes de su organización.

Muestre contenido en paralelo con el bloque de división vertical, ideal para comparaciones o información relacionada.

Incruste videos de Youtube  y LoomLoom para proporcionar contenido dinámico y tutoriales directamente dentro de su documentación.

Visualice procesos y flujos de trabajo con este bloque, ayudando a los usuarios a comprender claramente los pasos y secuencias.

Un menú amigable de "Lo que ve es lo que obtiene" que le permite formatear su contenido visualmente, haciendo que la creación de documentos sea intuitiva y sencilla.