herramienta para compartir documentos en línea showdoc v3.2.6
3.2.6
ShowDoc es una herramienta de documentación técnica y documentación API en línea que es muy adecuada para equipos de TI. A través de showdoc, puede utilizar fácilmente la sintaxis de rebajas para escribir hermosos documentos API, documentos de diccionario de datos, documentos técnicos, documentos de Excel en línea, etc. Si no desea editar documentos de rebajas, también puede utilizar las capacidades de automatización de showdoc para generar automáticamente documentos API a partir de comentarios del programa, o generar documentos automáticamente mientras depura la interfaz desde el cliente RunApi correspondiente (una herramienta de depuración de API similar a cartero). Al asignar miembros del proyecto y miembros del equipo, puede administrar fácilmente los permisos de los documentos del proyecto y la colaboración en equipo, y también puede compartir documentos con amigos para verlos. ShowDoc también admite clientes multiplataforma, incluidos win client, mac client, ios, android, etc., lo que lo hace más conveniente para el uso multiplataforma. Actualmente, más de 100.000 equipos de Internet utilizan showdoc, incluidos algunos equipos de empresas conocidas, como Tencent, Huawei, Baidu, JD.com, ByteDance, SF Express, etc.
1. Documentación API
Con el desarrollo de Internet móvil, BaaS (backend como servicio) se está volviendo cada vez más popular. El servidor proporciona una API y la aplicación o el front-end web pueden llamar datos fácilmente. ShowDoc se puede utilizar para escribir hermosos documentos API de manera muy cómoda y rápida.
2. Diccionario de datos
Un buen diccionario de datos puede explicar fácilmente la estructura de su base de datos a otros, como la definición de cada campo, etc.
3. Documentación
Puede utilizar showdoc para escribir instrucciones para algunas herramientas y también puede escribir algunos documentos de especificaciones técnicas para que el equipo los revise.
1. Compartir y exportar
Diseño web responsivo, los documentos del proyecto se pueden compartir en computadoras o dispositivos móviles para su visualización. Al mismo tiempo, también puedes exportar el proyecto a un archivo de Word para navegar sin conexión.
2. Gestión de permisos
(1), proyectos públicos y proyectos privados.
Hay dos tipos de proyectos en ShowDoc: proyectos públicos y proyectos privados. Cualquier usuario que haya iniciado sesión o no puede acceder a los proyectos públicos, mientras que los proyectos privados requieren una contraseña para autenticar el acceso. La contraseña la establece el creador del proyecto.
(2) Transferencia de proyecto
Los creadores de proyectos son libres de transferir proyectos a otros usuarios del sitio.
(3), miembros del proyecto
Puede agregar y eliminar fácilmente miembros del proyecto en proyectos de ShowDoc. Los miembros del proyecto pueden editarlo, pero no pueden transferirlo ni eliminarlo (solo el creador del proyecto tiene permiso)
(4), gestión de equipos
Puede colaborar mejor con su equipo utilizando la función de equipo de showdoc
3. Función de edición
(1), edición de rebajas
ShowDoc utiliza un editor de rebajas, que proporciona una excelente experiencia de edición y lectura. Si no conoce Markdown, busque "Comprensión y introducción a Markdown" en el motor de búsqueda.
(2) Inserción de plantilla
En la página de edición de ShowDoc, haga clic en el botón que se encuentra encima del editor para insertar fácilmente plantillas de interfaz API y plantillas de diccionario de datos. Después de insertar la plantilla, todo lo que queda es cambiar los datos, ahorrando mucho esfuerzo de edición.
(3), historia
ShowDoc proporciona una función de historial para la página y puede restaurar fácilmente la página a la anterior.
4. Multiplataforma
showdoc admite la versión de la aplicación móvil y la versión del cliente de computadora.
5. Automatización
(1) Los documentos se pueden generar automáticamente a partir de comentarios de código.
(2), equipado con cliente RunApi, interfaz de depuración y generación automática de documentos
