Las herramientas de documentación no siempre ofrecen la mejor experiencia. Varios wikis tradicionales son complicados y las alternativas en la nimbo son caras. Adecuado a la mala experiencia del adjudicatario y al costo de la documentación, abandoné la documentación por completo. Lo que rompió el envés del camello fue ver cómo la documentación se convertía en una colección de páginas inacabadas que nadie volvía a pasar revista.

Sin retención, me convencí de darle otra oportunidad a la documentación, y Docmost, el wiki colaborativo de código libre al que recurrí, inesperadamente brindó una experiencia de adjudicatario moderna y agradable. Lo configuré, lo usé por un tiempo y la documentación finalmente se siente indolora y confiable.

Redactar y organizar conocimientos en Docmost

Un editor en tiempo verdadero diseñado para documentación colaborativa

Docmost se diferencia de MediaWiki y de varios otros wikis tradicionales que se basan en reglas de formato rígidas. Ofrece un editor que fomenta la colaboración en tiempo verdadero, similar a las aplicaciones de productividad modernas como Notion. Como varias personas trabajan en la misma página simultáneamente, Docmost refleja las ediciones inmediatamente.

Docmost evita conflictos de estampación que requieren resolución manual. Esto le da en la praxis una sensación similar a Notion y Google Docs, donde cualquier persona con derechos de camino puede utilizar los documentos en cualquier momento. La única diferencia es que los documentos Docmost existen en su propio entorno alojado.

Su filosofía central son los espacios, que representan equipos, proyectos o departamentos. Organizo mis documentos en espacios para notas personales, documentación del servidor y guías de proyectos. Se negociación de separaciones ordenadas que tienen sus propias páginas y permisos.

Tiene una mostrador anexo sencilla con páginas anidadas, que te ayuda a encontrar contenido sin penuria de utilizar siempre la búsqueda. A medida que aumente la documentación, apreciará más la mostrador anexo. Pero las funciones de colaboración que más uso son el historial de páginas, los comentarios, las @menciones y el uso compartido manifiesto. Estas características hacen de Docmost una verdadera plataforma de colaboración para la documentación.

Las características que hacen que Docmost se sienta como una plataforma de conocimiento moderna

Ricas herramientas de estampación que facilitan la recital de la documentación

Destaca la flexibilidad del editor Docmost. Mientras que los sistemas wiki más antiguos se vuelven rígidos una vez que se va más allá del simple formato de encabezados y párrafos, Docmost utiliza herramientas de estampación visual y atajos familiares de Markdown. Recibo texto formateado instantáneamente cuando escribo Markdown. Esto parece natural porque ya estoy acostumbrado a usar Markdown.

Pero para cualquiera que no use Markdown, el editor de texto enriquecido admite tablas. Puede adicionar filas o columnas de encabezado y trabajar con una tabla de tamaño variable en emplazamiento de una cuadrícula fija. Las tablas son herramientas indispensables para documentar los pasos de configuración, listas de compatibilidad y comparaciones.

Utilizo bloques de sucesión para implementar explicaciones más profundas y pasos opcionales, manteniendo legibles las páginas de documentación largas. Las instrucciones principales se mantienen claras y los pasos adicionales están disponibles solo si alguno los necesita.

Las diversas herramientas de diagramación que admite ayudan mucho con la documentación técnica. Incluyo diagramas de dibujar.iobocetos de excalidrawy suscitar diagramas estructurados usando Sirena. Estas opciones me ayudan a evitar enlaces a fortuna externos y a apoyar la documentación en un solo emplazamiento. Aunque no uso mucho la integración KaTeX, es una excelente opción para cualquiera que escriba material más técnico.

A Docmost todavía le va correctamente con los detalles más pequeños:

• Los atajos de teclado aceleran el formateo

• Los archivos adjuntos se pueden adicionar directamente a las páginas.

• El modo azaroso mantiene cómodas las largas sesiones de estampación

• Un modo de recital/estampación evita ediciones accidentales cuando solo estás revisando el contenido.

Hacer que Docmost se ejecute en su propio servidor

El proceso de configuración es más sencillo que el de la mayoría de las herramientas autohospedadas.

En comparación con otras herramientas de código libre y autohospedadas que he usado, configurar Docmost es congruo sencillo. Recomiendo instalarlo a través de Docker. De esta forma, la anciano parte de la instalación se centra en un único archivo Docker Compose. Sólo tienes que ajustar un par de variables de entorno luego de descargar el Redactar plantilla y creando una carpeta. Aquí están los cuatro importantes:

• APP_URL: define dónde se accederá a su instancia

• APP_SECRET: una secreto de seguridad larga necesaria para que se ejecute la aplicación

• DATABASE_URL: conecta la aplicación a la pulvínulo de datos PostgreSQL

• REDIS_URL: conecta la aplicación a la instancia de Redis

Tener conocimientos básicos del servidor ayuda, pero a diferencia de algunas herramientas autohospedadas que he usado, no es necesario reunir dependencias para que se ejecute la aplicación.

SO

Windows, Linux, macOS

Revelador

Docmost

Maniquí de precio

Injustificado con opciones pagas, Código libre

Un Wiki preparado para empresas para que individuos y equipos gestionen el conocimiento de forma segura. Se puede implementar localmente y facilita la migración desde Confluence y Notion.

Cuidar el camino cuando varias personas usan el wiki

Los permisos y los grupos mantienen la documentación organizada

Las contribuciones de las personas son las que en realidad hacen que la documentación sea valiosa y Docmost implementa un sólido sistema de permisos. Todos los medios existen adentro de un espacio de trabajo. Sin retención, los espacios adentro de un espacio de trabajo tienen su propio conjunto de permisos que permiten a personas específicas adivinar, editar o regir páginas.

Es posible que todo su equipo pueda adivinar documentos, pero solo unos pocos contribuyentes pueden tener derechos de estampación. Incluso puede lanzarse restringir páginas de proyectos específicos a equipos que trabajen en ellas. Sin retención, Docmost utiliza grupos para simplificar los permisos. En emplazamiento de permitir individuos, puede crear grupos y asignar niveles de camino por peña. Pegar nuevos miembros del equipo a un peña les otorga el permiso asociado con ese peña.

Para equipos más pequeños o implementaciones personales de Docmost, las configuraciones típico utilizan correo electrónico y contraseña para la autenticación. Sin retención, para equipos grandes, la estampación empresarial permite otros tipos de autenticación, que incluyen:

• Integración LDAP

• SSO a través de proveedores SAML u OIDC

• Autenticación multifactor (MFA) mediante aplicaciones de autenticación

Dónde encaja Docmost entre las herramientas de documentación modernas

La única forma verdadera de entender si vale la pena probar Docmost es comparándolo con otras herramientas de documentación. La posterior tabla muestra cómo se compara con otras herramientas que he usado:

La diferencia más significativa es el alojamiento. Entre ellos, Docmost es el que en realidad está diseñado para ejecutarse en su servidor. Esto es importante porque me importa la propiedad de los datos.

Relacionado

Por qué mi suscripción a Notion Plus se amortiza sola cada mes

¿$10 al mes para comprobar que tengo mi vida en orden? Negociar.