Planes de apoyo a la creación de nuevos proyectos
| Profesional | Negocio | Empresa |
|---|---|---|
Un proyecto en Document360 sirve como un contenedor completo para todas sus necesidades de documentación. Encapsula los artículos, las categorías y subcategorías, la página de inicio, las cuentas de equipo, los lectores y los grupos (para proyectos privados y mixtos) y las configuraciones o ajustes personalizados. Este enfoque centralizado garantiza que su base de conocimientos esté organizada, sea fácilmente accesible y escalable.
¿Cómo crear un proyecto de base de conocimientos en Document360?
Los proyectos de Document360 están diseñados para agilizar el proceso de documentación, ofreciendo una forma estructurada y eficiente de gestionar la información. Ya sea que esté creando manuales de usuario, documentos de procesos internos o documentación API , un proyecto de Document360 proporciona el marco para almacenar, administrar y distribuir contenido de manera efectiva. Siga estos pasos para crear su proyecto de base de conocimientos.
Acceso al panel de control
Inicie sesión en el portal de Document360 con su cuenta para acceder al Salpicadero.
Si ha iniciado sesión y se encuentra en el portal de la base de conocimientos de otro proyecto, haga clic en el icono de Document360 en la parte superior izquierda para ser redirigido al Salpicadero.Haga clic en el botón +Proyectoen la parte superior derecha para crear un nuevo proyecto.
Elija su caso de uso
Seleccione su caso de uso principal para Document360 haciendo clic en Comenzar.
Caso de uso | Descripción |
Plataforma de base de conocimientos | Puedes crear un centro centralizado donde se almacenen todos los conocimientos y recursos de tu equipo. Ayuda a su equipo a encontrar respuestas rápidamente y mejora el autoservicio del cliente al proporcionarles un fácil acceso a la información que necesitan. |
Documentación de software/Documentación técnica | Puede organizar y mantener de manera eficiente todo su software o documentación técnica. Ayuda a su equipo a documentar las características del producto, las API, las notas de la versión y mucho más, asegurándose de que los desarrolladores y los usuarios tengan información clara y actualizada. |
Documentación de SOP | Puedes crear SOP detallados que tu equipo pueda seguir de forma coherente. Garantiza que todos se adhieran a los mismos procesos, reduce los errores y ayuda a incorporar nuevos empleados al proporcionarles pautas de procedimiento claras. |
Manual de usuario | Puede desarrollar manuales de usuario completos que guíen a sus clientes o miembros del equipo a través de las características y el uso de su producto. Ayuda a reducir las consultas de soporte al ofrecer instrucciones paso a paso y consejos para la solución de problemas. |
Documentación de la API | Documente información detallada sobre los puntos de conexión de la API, los formatos de solicitud y respuesta, los métodos de autenticación y ejemplos. Esto garantiza que los desarrolladores tengan una comprensión clara de cómo integrarse con sus API. Al seleccionar esta opción, se le redirigirá al flujo de configuración de la API. |
Otros | Elija esta opción si su caso de uso no se encuentra en las categorías predefinidas. Puede personalizar su base de conocimientos en función de las necesidades específicas de la organización o del proyecto. |
Seleccione una plantilla
Seleccione el tipo de contenido que creará en su proyecto de Document360. Puedes elegir hasta dos plantillas que se adapten a tus necesidades.
NOTA
En función de su selección, estas plantillas se incrustarán en su proyecto durante la creación. Sin embargo, su selección no le limita el uso de otras funciones o la creación de diferentes tipos de contenido.
Si seleccionó la documentación de la API como caso de uso, omitirá este paso y se le redirigirá a la configuración de la API .
Plantillas de plataforma de base de conocimientos
Si ha seleccionado la plataforma de la base de conocimientos en el paso 3, puede elegir dos plantillas cualesquiera de la lista siguiente.
Plantilla | Propósito |
Guías de inicio | Ayude a los nuevos usuarios a comprender rápidamente y comenzar a usar su producto con instrucciones claras paso a paso. Esto garantiza una experiencia de incorporación sin problemas. |
Guías prácticas | Proporcione instrucciones detalladas para tareas específicas, lo que permite a los usuarios utilizar y explorar completamente las funciones de su producto de manera eficiente. |
Preguntas frecuentes | Aborde las preguntas comunes en cualquier etapa del recorrido del usuario, ayudando a los usuarios a encontrar respuestas rápidas y reduciendo las consultas de soporte. |
Política y procedimientos | Describa los protocolos organizacionales esenciales, ayudando a los usuarios a comprender y cumplir con las pautas de la empresa de manera efectiva. |
Plantillas de software/documentación técnica
Si ha seleccionado Software/Documentación técnica en el paso 3, puede elegir dos plantillas cualesquiera de la lista a continuación.
Plantilla | Propósito |
Notas | Mantenga a los usuarios informados sobre actualizaciones, nuevas funciones, correcciones de errores y mejoras con cada versión de software. |
Documentación de diseño de software (SDD) | Describa la arquitectura y el diseño del software, incluidos los diagramas y las especificaciones para la orientación del desarrollo. |
Documentación de requisitos de software | Describa el propósito, las funcionalidades y el entorno del software para garantizar que el desarrollo se alinee con los objetivos del proyecto. |
Documentación de requisitos del producto (PRD) | Defina el propósito, el valor y las funcionalidades del producto para satisfacer las necesidades del usuario y los objetivos comerciales. |
Documentación del proceso | Pasos y procedimientos detallados involucrados en el desarrollo de software para estandarizar los flujos de trabajo y mejorar la eficiencia. |
Guía del usuario | Proporcione instrucciones completas sobre el uso de su producto, cubriendo todas las características y funcionalidades. |
Plantillas de documentación de SOP
Si ha seleccionado la documentación de SOP en el paso 3, puede elegir plantillas de la lista a continuación.
Plantilla | Propósito |
Políticas y procedimientos de cumplimiento | Asegúrese de que su organización cumpla con los requisitos normativos documentando las políticas que imponen el cumplimiento. |
Operación SOP | Mejore la eficiencia y la productividad mediante la estandarización de los procedimientos operativos en toda su organización. |
Plantillas de manuales de usuario
Si ha seleccionado el manual del usuario en el paso 3, puede elegir dos plantillas de la lista a continuación.
Plantilla | Propósito |
Manual de instalación | Proporciona toda la información de configuración necesaria, incluida la descripción general del producto, las especificaciones y las instrucciones de montaje, lo que garantiza un comienzo sin problemas con la plataforma de la base de conocimientos. |
Manual | Ofrece instrucciones de montaje y uso paso a paso con diagramas y advertencias de seguridad, ideales para una configuración precisa y advertencias de seguridad para un uso adecuado. |
Manual de mantenimiento | Proporcione instrucciones detalladas para el mantenimiento regular, la solución de problemas y los procedimientos de reparación para garantizar un rendimiento óptimo. |
Manual de formación | Proporciona orientación completa sobre la instalación, el funcionamiento y la solución de problemas, así como soporte para la formación de los usuarios y el uso eficaz de la plataforma. |
Manual de operaciones | Proporcionar instrucciones detalladas para el mantenimiento diario y la resolución de problemas, garantizando una gestión continua y eficaz de la plataforma de la base de conocimientos. |
Personaliza tu base de conocimientos
Introduce la URL de tu empresa. Document360 analizará su sitio y utilizará la IA para generar contenido relevante, elementos de marca y documentación estructurada.
Si desea omitir este paso, el dominio será el vinculado a su correo electrónico de registro de forma predeterminada.
Directrices de la marca
El nombre del proyecto, el idioma predeterminado, el logotipo de la marca y los colores de la marca se establecerán automáticamente en función de la URL proporcionada. Sin embargo, puede editar los campos si es necesario.
La configuración de idioma de su navegador determina el idioma predeterminado. El inglés se seleccionará de forma predeterminada si otros idiomas no son compatibles con el idioma de su navegador.
NOTA
Si eliges español o portugués brasileño como idioma predeterminado; el idioma del portal se establecerá en español o portugués de Brasil. De lo contrario, el inglés será el idioma predeterminado.
El logotipo de la marca y los colores primarios/secundarios se extraen de su sitio web. Si decide Omitir este paso, el nombre del proyecto se derivará de su correo electrónico de registro y se aplicarán el logotipo y los colores predeterminados de Document360.
Puede obtener una vista previa del sitio de la base de conocimientos en el lado derecho de la pantalla.
Establecer la privacidad de la documentación
Elija la configuración de privacidad deseada para su sitio:
Privado: restrinja el acceso a la base de conocimientos para que solo las cuentas de equipo puedan ver e interactuar con el contenido, manteniéndolo seguro e interno.
Público: Hacer que la base de conocimientos sea accesible para todos, incluidos los usuarios externos, permitiendo el acceso abierto a todo el contenido.
Mixto: combine el acceso privado y público permitiendo que algunas secciones de la base de conocimientos sean visibles para el público, mientras que otras secciones se restringen solo a las cuentas de equipo.
Haga clic en Siguiente para continuar.
Acceda al portal de la base de conocimientos de Document360
Una vez completada la configuración, acceda al portal de la base de conocimientos de Document360.
Para los usuarios que hayan seleccionado la plataforma de la base de conocimientos, la documentación de software/documentación técnica, la documentación de SOP o el manual de usuario como caso de uso: Document360 generará automáticamente artículos y categorías relevantes en función de los casos de uso seleccionados y del contenido de su sitio web. Cada categoría tendrá al menos 2-3 artículos generados por IA, y se crearán subcategorías si es necesario. Si el idioma seleccionado es compatible con Eddy AI, su documentación se generará en ese idioma. De lo contrario, se establecerá de forma predeterminada en inglés. Si no se encuentra contenido relevante en la URL proporcionada, verá artículos precargados basados en el caso de uso y las plantillas seleccionados, lo que le dará una ventaja en la creación de su contenido.
NOTA
Los artículos generados por Eddy AI se publicarán y luego se configurarán en modo borrador. Puede actualizar los artículos según sea necesario.
Para los usuarios que seleccionaron el caso de uso de documentación de API: Se le redirigirá al espacio de trabajo de documentación de API, donde:
Verá la referencia de API de la especificación de API que proporcionó durante la incorporación.
Si no proporcionaste una especificación de API, estará disponible una referencia de API de muestra (API de tienda de mascotas).
Cambiar entre proyectos de Document360
Una vez que haya creado sus proyectos en Document360, es posible que tenga que trabajar en varios proyectos o cambiar entre ellos para varias tareas. Document360 proporciona un conmutador de proyectos intuitivo para ayudarle a gestionarlo sin problemas.
Hay dos formas de cambiar de proyecto desde el portal de la base de conocimiento:
Uso del menú desplegable Proyectos
Desde el panel de control Proyectos
Cambiar de proyecto mediante el menú desplegable Proyectos
Desde cualquier módulo del portal de la Base de Conocimientos, haga clic en el menú desplegable del proyecto en la parte superior izquierda de la pantalla.
Puede ver el "Nombre del proyecto", el "Acceso al sitio" (público - , privado - o mixto ) y una etiqueta "Sandbox" si se trata de un proyecto Sandbox.
Haga clic en el proyecto que desea ver de la lista.
Cambiar de proyecto desde el panel de control Proyectos
Haga clic en el logotipo de Document360 en la parte superior izquierda.
Serás redirigido a la página "Mis Proyectos".
Se mostrará la lista de todos los proyectos que son propiedad o están asociados a su cuenta.
Haga clic en el proyecto al que desea navegar.
Preguntas frecuentes
¿Document360 admite diferentes idiomas en el flujo de incorporación?
Sí, Document360 ofrece soporte multilingüe en el flujo de incorporación, incluidos idiomas como inglés, español, portugués de Brasil, alemán y sueco. Sin embargo, dentro del portal de Document360, la compatibilidad lingüística se limita actualmente al inglés, el español y el portugués de Brasil.
¿Puedo personalizar el aspecto y la estructura de mi proyecto de Document360?
Sí, los proyectos de Document360 ofrecen amplias opciones de personalización. Puede personalizar el aspecto de su base de conocimientos diseñando su página de inicio, temas, agregando la marca de su organización, orientada al editor y organizando los artículos en una estructura jerárquica (categorías) que se adapte a sus necesidades de documentación.
¿Es posible controlar el acceso y los permisos dentro de los proyectos de Document360?
Absolutamente. Document360 ofrece un sólido control de acceso y configuración de permisos. Puede asignar roles y permisos a las cuentas de equipo, restringiendo o otorgando acceso a funciones y contenidos específicos en función de sus responsabilidades y requisitos.
¿Cómo ayuda Document360 con el control de versiones y el historial de documentación?
Los proyectos de Document360 mantienen un sistema integral de control de versiones de artículos denominado "Revisiones de artículos". Guarda y realiza un seguimiento automático de los cambios realizados en los artículos, lo que le permite volver a versiones anteriores si es necesario. Esto garantiza la integridad de su documentación y simplifica la colaboración en las actualizaciones de contenido.
¿Cómo puedo saber en qué proyecto estoy trabajando actualmente?
Puede comprobar el nombre del proyecto que se muestra en la parte superior izquierda de la pantalla en el portal de la Base de conocimientos.
¿Qué sucede si no veo el proyecto al que quiero cambiar?
Asegúrese de tener los permisos de acceso necesarios para ese proyecto. Si el proyecto sigue sin aparecer, póngase en contacto con el administrador de Document360 para obtener ayuda.
¿Qué es un proyecto "Sandbox" y en qué se diferencia de otros proyectos?
Un proyecto Sandbox es un entorno de prueba en el que puedes experimentar sin afectar a tus proyectos en vivo. Tendrá una etiqueta "Sandbox" en el menú desplegable del proyecto.
¿Qué significa "Acceso al sitio" en el menú desplegable del proyecto?
"Acceso al sitio" indica si el proyecto es público, privado o mixto. Esto define el nivel de accesibilidad del contenido del proyecto.
¿Cómo puedo solicitar acceso a un proyecto al que no estoy asociado actualmente?
Póngase en contacto con el administrador del equipo o el propietario del proyecto para solicitar acceso al proyecto deseado.
¿Qué sucede si Eddy AI no puede generar contenido de mi sitio web para los artículos predeterminados?
Si Eddy AI no puede extraer suficiente contenido de su sitio web, el sistema utilizará plantillas predeterminadas basadas en el caso de uso seleccionado.