5 sistemas para incorporar documentación en tu sitio

Construyendo paso a paso tu proyecto web, notarás que ciertos servicios innovadores requieren la documentación pertinente para que tus clientes se sientan seguros al utilizar tus servicios en línea.

Si bien existen variadas formas de llevar este proyecto adelante, te proponemos en este artículo un sistema de documentación integral para que la información de los procesos, servicios y otros recursos relevantes se procese jerárquica y ordenadamente.
Alternativamente, si ya sabes cómo hacer un blog sencillo, te sentirás tentado de utilizarlo con fines de documentación. Pero para una lógica de negocios de magnitud relativamente compleja, no es recomendable porque no dispone de todas las herramientas de gestión que se requieren.




Las prestaciones que encontrarás en estos sistemas son similares a las conocidas a través de Wikipedia. La cual es un completo sistema no solo de documentación en general, sino también de edición colaborativa y soportada por la comunidad, con hilos de discusiones y señalización de cambios para una mejora continua sobre la propia calidad del contenido.

En términos generales, estos sistemas comparten requisitos con otros administradores de contenidos, como pueden ser algoritmia PHPy la presencia de un motor de bases de datos como MySQL.

A continuación, se encuentran enumerados los proyectos web que llevarán adelante este proceso:

#1: MediaWiki:

Un proyecto de Wikimedia Foundation, la organización que mantiene y da vida a Wikipedia, la enciclopedia más famosa de internet. Este software es el mismo que utiliza la propia enciclopedia para mantenerse funcionando, disponible para cualquiera que la necesite como parte de su filosofía abierta de software y sin fines de lucro.

La edición del contenido está disponible para cualquiera que quiera mejorarlo, aunque para ciertos proyectos puede ser restringido a través de un sistema de permisos. Está programado en PHP, es muy potente y puede instalarse en una enorme variedad de servidores. Requiere bases de datos MySQL para almacenar el contenido y los parámetros.

Como a mayoría de los sistemas wikis, MediaWiki utiliza un lenguaje de marcado para representar el contenido con formato adecuado para visualizarse de forma amigable. Además, incluye un editor de texto enriquecido para facilitar la edición y creación de contenido sin necesidad de manipular etiquetas HTML ni parámetros programables de estilo.

#2: DokuWiki:

Cumple con los estándares y es un sistema muy simple de usar. Está preparado para crear un sistema de documentación de cualquier tipo. Orientado a compañías sencillas, grupos de trabajo y equipos de desarrolladores.
Funciona a través de una sintaxis que asegura la correcta legibilidad de los archivos de datos fuera de la wiki, y facilita la creación de textos estructurados. Toda la información se almacena en archivos de texto plano, evitando costosas (en precio y en tiempo computacional) conexiones con bases de datos. De esta forma, este tipo de sistema, conocido como database-lesses uno de los más livianos y eficientes que se pueden encontrar, mientras que te permite ahorrar en requisitos técnicos para hacerlo funcionar.

Sus características se resumen a:· Instalación sencilla, evitando largos y complicados procesos.
· Pocos requisitos técnicos, gran cantidad de posibilidades.
· Listas de control incorporadas.
· Gran cantidad y variedad de extensiones.
· Soportado en alrededor de 50 idiomas.
· Independiente del dispositivo.
· De código abierto.

#3: PmWiki:

Sistema de documentación wiki para creación colaborativa y mantenimiento de sitios web. Las páginas creadas con este sistema se visualizan de forma usual y completamente normal en comparación con otras páginas web. La diferencia radica en el botón de editar que permite modificar el contenido o crear nuevas páginas con un editor en línea. De esta forma, podrás enfocarte en el contenido y no en la plataforma, pudiendo escribir sin necesidad de conocer sobre HTML o CSS.

La edición no necesariamente está librada a la comunidad, puede restringirse a un grupo selecto de autores o editores.

Este sistema permite la edición del aspecto visual a través de plantillas predefinidas, las cuales también puedes modificar para una mejor personalización y concordancia con la identidad corporativa.

Incorpora algunas funciones de seguridad útiles como:

• Protección contra SPAM: bloqueando direcciones IP, limitando la cantidad de URL no aprobadas y encriptando la dirección de correo electrónico (a través de un plugina adicionar
•  Protección con contraseña: Para la administración del sitio, grupos y páginas en particular.

#4: Wikkawiki:

Es flexible, cumple con los estándares y es muy liviano. Escrito en PHP, utiliza bases de datos MySQL para almacenar las páginas y todo su contenido. Está diseñado para ser veloz, Seguro y extensible.

Este proyecto abarca numerosas soluciones relacionadas para mejorar su alcance de uso. Como ejemplo podemos observar numerosos proyectos de integración para incorporar el sistema wiki en distintos ámbitos web ya existentes como blogs, foros y otro software relacionado.

Para proporcionar facilidad de uso en todos sus procesos, Wikkawiki incorpora asistentes basados en web para instalar y actualizar, sin la necesidad de disponer de permisos raíz (root) Además, las problemáticas de seguridad son tenidas en cuenta con filtros antispam como listas negras y navegación segura.

#5: GitBook:

Se diferencia del resto por no ser un software wiki, sino que es una aplicación diferente del tan conocido sistema de control de versión y sincronización: Git. Este software utiliza la potencia de la base de Git para crear un potente sitio de documentación, lo que lo convierte en una excelente opción si los sistemas anteriores no son completamente de tu agrado.

Si bien dispone de planes de pago, GitBook es gratuito para pequeños equipos de hasta 2 usuarios, además de ser completamente gratuito para equipos de código abierto y sin fines de lucro.


Los sistemas descritos en este artículo te ayudarán a mantener y proveer una plataforma integral con la documentación que tus clientes o usuarios necesitan. El sistema de control de versión que proponen frente a otros sistemas los convierte en la opción óptima en cuanto a la administración de los recursos de contenido y el tiempo de implementación necesario. Dejando atrás otras propuestas, a veces más tentadoras, pero menos eficientes como blogs y foros.