Documentación, categorías y versiones

Documentación permite reunir procedimientos, instructivos y conocimiento técnico dentro de la organización. La información nace privada y puede referirse a la propia organización o a una Empresa relacionada que actúa como cliente o proveedora.

Disponibilidad: organizaciones Profesional y Empresa. La visibilidad y las acciones dependen del rol y de la categoría. Nivel: Intermedio.

Para qué sirve

Use una página para un procedimiento concreto y un manual para ordenar varias páginas o planos como una sola obra. Cada biblioteca identifica claramente de quién se está hablando: Mi organización o una Empresa relacionada de su propio registro.

Una Empresa relacionada puede seguir siendo simbólica. En ese caso la documentación funciona normalmente como información interna, pero no se puede compartir con la contraparte hasta que su ficha quede vinculada con una Empresa registrada.

Requisitos

Tener una membresia activa y el permiso Ver documentación.
Para crear categorías, páginas, manuales o planos: Editar documentación y nivel Editar en la categoría.
Para dejar una versión oficial: Publicar documentación.
Para cambiar niveles por categoría o compartir: los permisos administrativos correspondientes.

Los propietarios y administradores tienen estas capacidades. En los demás roles se habilitan por separado desde Ajustes, Roles. Un rol puede, por ejemplo, leer procedimientos sin poder editar ni publicar.

Lectura y modo avanzado

La biblioteca abre en Lectura para que pueda encontrar y consultar contenido sin controles de edición alrededor. La navegación, categorías, filtros, documentos, adjuntos, exportación, detalles e historial siguen disponibles.

Si su rol tiene alguna capacidad de comentario, edición o administración, aparece el selector Lectura / Avanzado en las vistas donde hay herramientas aplicables. Avanzado despliega creación, permisos, archivo, edición, compartición, comentarios, sugerencias, estructura de trabajo y publicación. La elección se recuerda durante la sesión de la pestaña actual y por separado para cada persona y organización. Entrar al editor siempre muestra el espacio de trabajo completo y no cambia esa preferencia.

La lista Compartida conmigo permanece en Lectura. Al abrir un documento compartido con nivel Comentar o Editar, aparece el selector para acceder a las herramientas autorizadas.

Este selector solo organiza la interfaz: no concede permisos ni oculta contenido que el rol esté autorizado a leer. Si no aparece, su rol no tiene acciones avanzadas aplicables en esa vista.

Crear y organizar contenido

Abra Documentación.
En la primera visita, elija Propio o una de las Empresas relacionadas disponibles. Abrir esta portada no crea una biblioteca por sí solo; cuando todavía no existe, ReportArea ofrece crearla de manera explícita a quien tenga permiso.
Elija una biblioteca existente. ReportArea distingue que la biblioteca exista de que su rol pueda verla; una referencia inválida o inaccesible no cae silenciosamente en la biblioteca propia.
Cree una categoría o seleccione una existente.
Elija Nuevo documento y seleccione página, manual o plano.
Indique título y categoría y, en una página, escriba el contenido Markdown.
Guarde un punto de control cuando quiera dejar una referencia recuperable.

En un contexto Propio o de contraparte específica, la portada abre o permite crear expresamente la biblioteca correspondiente. En General, el selector muestra Propio y las empresas agrupadas con badges de simbólica o vinculada, rol, estado y un dato secundario cuando ayuda a distinguir nombres duplicados.

Las categorías pueden anidarse hasta ocho niveles. Un manual contiene páginas y planos ordenados, pero no otros manuales. Cada página o plano puede formar parte de un solo manual y conserva el mismo sujeto y categoría del manual.

La biblioteca muestra cada documento que puede consultar, incluso las páginas y planos contenidos por un manual. Cada manual encabeza un bloque y sus hijos aparecen ordenados debajo; los documentos que no pertenecen a uno quedan en una sección independiente. Si una búsqueda, filtro o página de resultados muestra un hijo sin el resto del bloque, una cabecera contextual identifica y enlaza a su manual. La búsqueda por título y el filtro por tipo también incluyen los hijos. Las categorías quedan en un bloque separado porque organizan temas y permisos, pero no son documentos.

Las vistas de documentación usan un espacio más amplio en pantallas grandes. Los nombres completos se acomodan en varias líneas en lugar de recortarse. En teléfonos y tabletas, los manuales y sus hijos forman una lista vertical ordenada, los controles se adaptan al ancho disponible y no es necesario desplazarse hacia los costados. Las páginas conservan un ancho de texto cómodo para leer aunque la vista general sea amplia.

Para agregar contenido dentro de un manual, abra el manual, tome el turno de edición y use Agregar página o plano en su estructura. El elemento nuevo queda visible para los editores en la biblioteca; quienes tienen nivel Ver lo reciben cuando se publica la nueva revisión del manual. Al abrir una página o plano de un manual, la ruta superior permite volver al manual; en el editor de la estructura, cada hijo también tiene accesos directos para abrirlo o editarlo.

Escribir y revisar

El editor guarda Markdown como fuente y ofrece herramientas para títulos, listas, tablas, enlaces, código e imágenes privadas. La vista previa elimina HTML incrustado, enlaces inseguros e imágenes remotas. Esto evita que una página cargue seguimiento externo o código inesperado.

Puede adjuntar PDF, JSON, Markdown, texto, JPEG, PNG y WebP. Los archivos siguen siendo privados y siempre se descargan mediante una comprobación de permisos. Un PDF se puede conservar como adjunto, pero no se dibuja encima de él desde el editor de planos.

La edición funciona por turnos. Una persona toma el turno de la página, plano o estructura del manual y el resto ve quién está trabajando. Se puede solicitar la entrega; solo un turno vencido puede tomarse sin respuesta. Si hay cambios pendientes, ReportArea crea antes un punto de recuperación.

Versiones y publicación

El autoguardado protege la copia de trabajo, pero no reemplaza el historial. Crear checkpoint crea un punto de control inmutable. Publicar crea otra revisión oficial que los lectores pueden consultar.

Restaurar una revisión no borra el trabajo posterior: genera una nueva versión basada en la elegida.
Archivar conserva versiones, comentarios y actividad; no elimina fisicamente el documento.
Publicar un manual fija al mismo tiempo las revisiones de todos sus hijos para que el resultado sea coherente.
Si el manual publicado recibe una página nueva u otro cambio, los editores ven Cambios sin publicar y una estructura En preparación. Quienes tienen nivel Ver siguen viendo y abriendo solamente la versión fijada por la publicación anterior hasta que se publique una revisión nueva; el nivel Comentar conserva el acceso al historial que le corresponde.
Si otra persona modifico el documento desde una vista antigua, la aplicacion pide recargar en lugar de sobrescribir sus cambios.

Los comentarios y sugerencias quedan ligados a la versión revisada. Una sugerencia que ya no coincide con el texto o plano actual se marca para resolución manual.

Permisos y privacidad

Cada categoría asigna a los roles uno de estos niveles: Sin acceso, Ver, Comentar o Editar. Una regla definida en una subcategoría reemplaza la heredada de su categoría superior. El nivel nunca puede superar los permisos generales del rol.

Todo contenido es privado por defecto. Documentar una Empresa relacionada no le concede acceso, aunque ya use ReportArea. Compartir es una acción separada, disponible solo entre Empresas vinculadas y explicada en la guía de planos y colaboración.

Una empresa simbólica puede documentarse como sujeto interno, pero no aparece como destinataria de compartición porque no existe un perfil receptor. Elegirla como contexto tampoco concede acceso a otra persona ni cambia las reglas de categoría.

Caso práctico

Una empresa crea la categoría Operaciones, un manual Apertura de sucursal y páginas para seguridad, inventario y puesta en marcha. Soporte puede comentar, Infraestructura puede editar y solo Gestión publica. Al restaurar una instrucción anterior, el historial nuevo sigue mostrando quién hizo el cambio y desde qué versión partió.

Límites actuales

No hay edición simultánea del mismo contenido ni trabajo offline; la colaboración es por turnos.
No hay traducción automática. Una página puede indicar su idioma y relacionarse con una traducción creada por el equipo.
El Markdown admite hasta 2 MiB. Cada documento admite 25 adjuntos de hasta 20 MiB cada uno.
No existen enlaces públicos anónimos para una biblioteca o documento.
Archivar conserva el historial y no ofrece eliminación definitiva desde la interfaz.