PMAN0 — Manual del Sistema
1 Identificación
2 Naturaleza del documento
PMAN0 es el Manual del Sistema y constituye el marco metodológico general para el desarrollo y administración de proyectos documentales asistidos por inteligencia artificial.
Establece los principios, criterios y convenciones generales que permiten organizar los componentes de un proyecto, identificar sus recursos, establecer relaciones entre documentos y administrar su evolución.
3 Ubicación
Ubicación de referencia: generico/PMAN0
La ubicación indicada constituye una ubicación de referencia dentro de la organización documental del Proyecto de Publicaciones.
La ubicación física o de almacenamiento de un recurso podrá modificarse sin alterar su identificador ni las referencias documentales que lo utilicen.
4 Propósito
Definir la metodología general utilizada para desarrollar y administrar proyectos documentales asistidos por inteligencia artificial.
Establece los criterios generales para:
- organizar los recursos;
- estructurar la documentación;
- administrar dependencias;
- identificar recursos;
- establecer relaciones;
- mantener referencias;
- facilitar la reutilización;
- y permitir la evolución ordenada del sistema.
5 Objetivos
PMAN0 tiene como objetivos:
- definir la metodología general;
- establecer una arquitectura documental de referencia;
- definir categorías generales de recursos;
- establecer convenciones de identificación;
- definir principios para las relaciones entre recursos;
- facilitar la localización y reutilización de recursos;
- mantener la trazabilidad documental;
- y permitir la aplicación de la metodología en diferentes proyectos y organizaciones.
6 Alcance
PMAN0 establece criterios generales aplicables a proyectos documentales asistidos por inteligencia artificial. Su alcance comprende:
- arquitectura general;
- tipos de recursos;
- identificación de recursos;
- organización documental;
- relaciones entre recursos;
- dependencias;
- ubicación;
- principios de administración;
- y evolución del sistema.
7 Arquitectura general
Un proyecto podrá componerse, según sus necesidades, de diferentes tipos de componentes y recursos. Entre ellos podrán encontrarse:
La arquitectura concreta de cada proyecto deberá establecerse en su documentación de configuración.
8 Tipos generales de recursos
PMAN0 establece las siguientes categorías generales de recursos.
8.1 Documentos
- PDOC
- Manuales
- Informes
- Guías
- Procedimientos
- Otros documentos
8.2 Chats
- Organización
- Marca
- Publicaciones
- Laboratorio
- Otros chats especializados
8.3 Bases de conocimiento
- Base documental
- Manual de conocimiento
- Otros conjuntos estructurados
8.4 Recursos gráficos
- Logotipos
- Fotografías
- Plantillas
- Ilustraciones
- Otros recursos gráficos
8.5 Recursos audiovisuales
- Videos
- Audios
- Otros recursos audiovisuales
8.6 Recursos externos
- Sitios web
- Documentación pública
- Bibliografía
- Otras fuentes externas
Las categorías anteriores constituyen una clasificación general. Cada proyecto podrá establecer categorías adicionales cuando resulte necesario.
9 Convención de identificadores
Cada recurso que deba ser referenciado dentro del sistema deberá disponer de un identificador permanente y único.
Los documentos y demás recursos deberán hacer referencia al identificador correspondiente, evitando utilizar como referencia principal su ubicación física.
Ejemplos:
10 Identificador y ubicación
El identificador y la ubicación son elementos diferentes.
Identificador
Permite reconocer de manera permanente un recurso.
Ubicación
Permite determinar dónde se encuentra almacenado o disponible el recurso.
11 Organización de referencia
La organización general de un proyecto podrá estructurarse mediante los siguientes componentes:
- Proyecto;
- Configuración;
- Documentación;
- Base de conocimiento;
- Manual de conocimiento;
- Chats;
- Campañas;
- Publicaciones;
- Recursos.
Esta organización constituye una estructura metodológica de referencia.
La ubicación efectiva de los archivos y recursos podrá encontrarse en:
- almacenamiento local;
- servidor;
- nube;
- sitio web;
- gestor documental;
- u otra infraestructura disponible.
La infraestructura de almacenamiento no modifica la arquitectura documental definida por el proyecto.
12 Relaciones entre recursos
Los recursos podrán mantener diferentes tipos de relaciones. Entre ellas:
- dependencia;
- referencia;
- derivación;
- especialización;
- pertenencia;
- complementariedad;
- sustitución;
- y otras relaciones necesarias.
Las relaciones deberán utilizar los identificadores de los recursos correspondientes.
13 Dependencias
Las dependencias deberán establecerse de manera que pueda determinarse qué recursos requieren otros recursos para su interpretación, funcionamiento o aplicación.
Cuando un documento dependa de otro, la dependencia deberá poder identificarse mediante los respectivos identificadores.
Los proyectos concretos deberán documentar sus dependencias según la estructura definida en su configuración.
14 Fuente de verdad
Cada recurso deberá mantener una única fuente de verdad.
Un recurso podrá ser utilizado por varios documentos, asistentes o chats, pero su contenido original deberá mantenerse identificado en un único recurso de referencia.
15 Reutilización de recursos
Un mismo recurso podrá ser utilizado por diferentes componentes del proyecto. Por ejemplo, un documento de referencia podrá ser utilizado simultáneamente por:
- un asistente;
- un chat;
- una campaña;
- y otros documentos.
La reutilización deberá realizarse mediante el identificador del recurso correspondiente.
16 Ubicación de los recursos
La ubicación de un recurso podrá variar durante la evolución del proyecto.
Los proyectos podrán establecer diferentes ubicaciones de almacenamiento de acuerdo con sus necesidades.
La ubicación deberá registrarse en la documentación o catálogo correspondiente cuando sea necesaria para localizar el recurso.
El cambio de ubicación no deberá implicar necesariamente la creación de un nuevo identificador.
17 Aplicación de la metodología
Cada proyecto deberá desarrollar su propia configuración a partir de la metodología establecida en PMAN0.
La configuración del proyecto deberá determinar, según corresponda:
- estructura;
- convenciones;
- recursos;
- ubicaciones;
- relaciones;
- dependencias;
- componentes;
- asistentes;
- chats;
- y demás elementos necesarios.
18 Evolución
La metodología podrá ampliarse mediante nuevas versiones de PMAN0. Las modificaciones deberán:
- mantener su función metodológica general;
- preservar la coherencia del sistema;
- evitar incorporar información específica de una organización;
- evitar incorporar información específica de un proyecto particular;
- y considerar el impacto sobre las configuraciones existentes.
Cuando una modificación de PMAN0 afecte criterios utilizados por proyectos existentes, deberá revisarse su compatibilidad con dichas configuraciones.
19 Control de versiones
PMAN0 deberá mantener control de versiones. Cada versión deberá identificar como mínimo:
- código;
- nombre;
- versión;
- fecha de actualización;
- estado;
- y cambios principales.
Las versiones anteriores deberán conservarse cuando resulte necesario para mantener la trazabilidad metodológica.
20 Principios fundamentales del sistema
El sistema se basa, entre otros, en los siguientes principios:
- Cada recurso tiene un único identificador.
- El identificador es independiente de la ubicación física.
- Un recurso puede ser utilizado por varios documentos o componentes.
- Las referencias documentales deben utilizar identificadores.
- Las ubicaciones físicas pueden modificarse sin afectar los identificadores.
- Cada recurso debe mantener una única fuente de verdad.
- Las relaciones y dependencias deben poder identificarse.
- La configuración específica de un proyecto no debe confundirse con la metodología general del sistema.
- La documentación deberá mantener trazabilidad durante su evolución.
21 Relación con la configuración del proyecto
PMAN0 constituye el marco metodológico general.
La configuración de cada proyecto deberá aplicar sus principios de acuerdo con las características y necesidades del proyecto.
En el caso del Proyecto de Publicaciones:
Los documentos posteriores deberán mantener coherencia con ambos niveles.
22 Relación con documentos específicos
Los documentos específicos de una organización o implementación deberán desarrollarse dentro de la estructura definida por el proyecto correspondiente.
La arquitectura documental podrá definir diferentes tipos de documentos específicos que una organización podrá utilizar según sus necesidades.
PMAN0 no define:
- organizaciones concretas;
- perfiles institucionales;
- campañas concretas;
- asistentes específicos;
- chats específicos;
- ni recursos particulares.
Estos elementos deberán ser desarrollados en la documentación correspondiente.
23 Regla fundamental
La metodología define los principios y convenciones generales; la configuración del proyecto determina cómo se aplican esos principios en un proyecto determinado.
24 Relación documental
La relación metodológica de referencia es:
Dentro de esta estructura, PDOC0 constituye la configuración concreta del Proyecto de Publicaciones, mientras que PMAN0 permanece como referencia metodológica general.