Project

General

Profile

Manual de usuario de cosmoSys » History » Release 2

Txinto Vaz, 12/01/2025 08:50 PM

1 2 Txinto Vaz
# Manual de Usuario de cosmoSys
2 1 Txinto Vaz
3
## Datos del producto
4
- **Nombre del sistema:** cosmoSys
5
- **Version:** _Completar_
6
- **Fecha:** _Completar_
7
- **Responsable de la informacion:** _Completar_
8
9
## Publico objetivo
10
Personal de una empresa de ingenieria con estructura matricial:
11
- Usuarios asignados a proyectos con roles específicos por proyecto (como en Redmine).
12
- Perfiles habituales: jefes de proyecto, responsables de disciplina, ingenieros de distintas especialidades y PMO.
13
- Nivel técnico: usuarios familiarizados con gestión de tareas/proyectos y uso básico de herramientas web.
14
- Dispositivos: uso principal en escritorio/portátil; acceso web.
15
16
## Requisitos previos
17
- Software necesario: Acceso a una instancia de cosmoSys configurada para la organizacion (adaptada a proyectos y familias).
18
- Accesos y permisos: Credenciales de usuario; permisos de creacion de proyectos otorgados por el administrador cuando aplique.
19
- Datos de prueba o entorno: _Completar_
20
21
## Conceptos clave
22
- **Item**: unidad base (equivalente a una "issue" en Redmine) que en cosmoSys se usa de forma generica para tareas, requisitos o nodos de modelos.
23
- **Relaciones**: enlaces entre items (padre-hijo, depende de, bloquea, duplicado, etc.).
24
- **Familia de proyecto**: conjunto de proyectos de un mismo arbol Redmine (proyecto raiz y todos sus subproyectos). Un proyecto raiz es aquel sin proyecto padre (relacion "parent" vacia). Los items comparten contexto e identificadores legibles dentro de esa familia.
25
- **csID (identificador legible)**: identificador propio de cosmoSys para cada item (formato `csID-proyecto` + guion + numero de 5 cifras). Es unico por familia y no cambia salvo accion explicita de administracion.
26
- **csInfo**: clase de item (tracker en Redmine) orientada a estructurar contenidos en arbol para transcribir a documentos (capitulos/secciones).
27
- **csRef**: clase de item (tracker en Redmine) para referencias documentales (wiki, documentos, URLs, ficheros, citas) clasificadas como documentos de referencia, aplicables o de conformidad.
28
- **Diagrama jerarquico**: diagrama que muestra items padres e hijos como cajas anidadas (analogas a nodos expandidos en el editor de arbol o a capitulos/subcapitulos del MainReport).
29
- **Diagrama de dependencias**: diagrama que muestra items como cajas y relaciones dirigidas (bloquea a, precede a, copiado de, relacionado con). "Relacionado con" es bidireccional; las demas se leen en ambos sentidos (p.ej., bloquea a / es bloqueado por).
30
- **Vista/Editor de arbol**: vista del proyecto que muestra los items como nodos jerarquicos. Permite reorganizar arrastrando y soltando nodos y navegar abriendo/cerrando subarboles.
31
- **MainReport**: vista del proyecto en formato documento; los items se muestran como capitulos y subcapitulos. Permite configurar que campos se muestran/ocultan, si se incluyen diagramas contextuales (diagramas jerarquicos y de dependencias centrados en el item), y filtrar items por tipo o valores de campos. Puede volcarse a DOCX/ODT/HTML.
32
33
## Identificador csID de los items
34
- Estructura: `csID del proyecto` (acronimo corto, sin guiones) + `-` + numero de 5 cifras empezando en `00000` segun orden de creacion en el proyecto. Ejemplo: proyecto "My Project" con csID `MPR` genera `MPR-00000`.
35
- Unicidad: unico dentro de la familia de proyectos (arbol completo). No pueden repetirse csID de proyecto en la misma familia.
36
- Inmutabilidad: no cambia aunque el item se mueva a otro proyecto de la familia; renombrar solo es posible via accion explicita del administrador y se evita para no perder trazabilidad.
37
- Familias distintas: pueden existir csID iguales en familias diferentes.
38
- Busqueda: siempre parte de un proyecto; el algoritmo recorre la familia (sube a raiz y desciende por subproyectos) para encontrar items/proyectos con ese csID.
39
- Uso en ODS: las plantillas de importacion/exportacion usan csID para identificar items y sus relaciones al crear o modificar datos.
40
41
## Vision general
42
cosmoSys esta implementado como un plugin de Redmine y añade varias capacidades:
43
- Representacion grafica de la estructura de items y sus relaciones (incluida una vista/editor de arbol y la vista MainReport) para entender dependencias y jerarquias de un vistazo y reorganizarlas con arrastrar/soltar.
44
- Visualizacion tipo libro: los proyectos pueden verse como un documento con capitulos (items) y subcapitulos (items dentro de items).
45
- Identificadores csID mas legibles y contextuales dentro de cada familia de proyecto para localizar items sin recurrir a IDs globales largos.
46
- Generacion de informes estructurados (DOCX/ODT/HTML) basados en MainReport, con tabla de contenidos viva, diagramas embebidos ajustados a pagina y plantillas personalizables.
47
- Importacion y exportacion enriquecida de items a hojas de calculo ODS con plantillas guiadas.
48
- Herramientas de administracion que automatizan la carga masiva de proyectos a partir de WBS.
49
- Plataforma para otros plugins especializados (p.ej., cosmoSys-Req para gestion profesional de requisitos, cosmoSys-PORIS como repositorio de modelos PORIS, cosmoSys-Git para sincronizar un repositorio Git espejo de un proyecto con las importaciones/exportaciones ODS, y otros).
50
- Referencias documentales mediante items csInfo/csRef y matrices de referencias en MainReport e informes exportados.
51
52
## Plugins adicionales
53
- cosmoSys-Req: gestor profesional de requisitos; depende de cosmoSys y cosmoSys-Git.
54
- cosmoSys-PORIS: repositorio de modelos PORIS (comportamiento y configurabilidad); depende de cosmoSys y cosmoSys-Git.
55
- cosmoSys-Git: sincroniza un repositorio Git espejo de un proyecto para gestionar importaciones/exportaciones ODS y obtener instantaneas del proyecto; depende de cosmoSys.
56
57
## Diagramas
58
- Tipos:
59
  - Jerarquico: estructura padre-hijo como cajas dentro de cajas (equivalente a nodos expandidos en el arbol o capitulos/subcapitulos en MainReport/exportaciones).
60
  - Dependencias: relaciones dirigidas entre items (bloquea a / es bloqueado por, precede a / sucede a, copiado de / copiado en) y la relacion bidireccional "relacionado con" con flechas.
61
- Alcance:
62
  - Centrados en proyecto: desde el detalle del proyecto, un diagrama de cada tipo que incluye todos los items del proyecto, incluso los aislados sin padre o sin relaciones.
63
  - Centrados en un item: desde el detalle de un item, cada diagrama arranca en ese item y expande solo su entorno conectado; si no hay camino jerarquico o de relaciones hacia otro item, ese item y sus relaciones no se muestran.
64
65
La combinacion genera cuatro vistas: jerarquico del proyecto, dependencias del proyecto, jerarquico del item y dependencias del item.
66
67
## Flujo principal
68
1. _Acceso a cosmoSys y seleccion de un proyecto activo: Completar_
69
2. _Busqueda o creacion de un item con csID dentro del proyecto/familia: Completar_
70
3. _Exploracion en diagramas (jerarquico/dependencias), en la vista/editor de arbol o en MainReport para revisar y, si aplica, reorganizar la jerarquia y ajustar la visibilidad de campos: Completar_
71
72
## Roles y permisos
73
cosmoSys hereda el sistema de roles de Redmine y se adapta a la organizacion. Los nombres Manager, Colaborador y Lector son ejemplos tipicos de la configuracion base; las organizaciones suelen copiarlos, renombrarlos y ajustarlos (p.ej., "jefe de departamento", "jefe de proyecto" a partir de Manager; "ingeniero informatico", "ingeniero de sistemas", "tecnico de laboratorio" a partir de Colaborador; "interesado", "supervisor", "cliente" a partir de Lector).
74
75
| Ejemplo de rol | Que puede hacer | Restricciones |
76
| --- | ---------------- | ------------- |
77
| Manager de proyecto | Crear proyecto (si tiene permiso), configurar el equipo seleccionando usuarios y asignandoles roles (heredables si se define en configuracion), crear/editar items, ver la vista grafica completa | Solo en proyectos donde es manager; permisos de creacion otorgados por administrador |
78
| Colaborador | Actualizar items asignados, comentar, seguir relaciones en la vista | No modifica configuraciones de proyecto ni permisos |
79
| Lector | Ver items y relaciones | Sin edicion |
80
81
> Los roles son apilables: un usuario puede tener varios roles en un proyecto y sus permisos se suman. Puede haber varios usuarios con el mismo rol (incluido varios managers) o ninguno; si no hay manager, el administrador de cosmoSys/Redmine configura el equipo. Los equipos se definen por proyecto; pueden heredarse segun la configuracion que establezca el manager.
82
83
## Tareas frecuentes
84
Instrucciones paso a paso para las acciones mas comunes. Incluye capturas o comandos cuando apliquen.
85
86
### Reorganizar la jerarquia en la vista/editor de arbol
87
1. Accede al proyecto activo y abre la vista/editor de arbol.
88
2. Expande los subarboles necesarios para localizar el item a mover.
89
3. Arrastra el nodo y suelta sobre el nuevo padre o posicion permitida.
90
4. Verifica que la jerarquia se actualiza y que las relaciones esperadas se mantienen.
91
92
### Usar la vista MainReport
93
1. Accede al proyecto activo y abre la vista MainReport.
94
2. Configura los campos visibles y decide si mostrar los diagramas contextuales de cada item.
95
3. Aplica filtros para ocultar items por tipo o por valores de campos.
96
4. Navega el documento como capitulos/subcapitulos para revisar el contenido estructurado.
97
98
### Exportar MainReport a DOCX/ODT/HTML
99
1. Prepara la vista MainReport con campos y diagramas segun necesidad.
100
2. Elige el formato de salida (DOCX, ODT o HTML).
101
3. Selecciona la plantilla del informe (puedes usar las plantillas patron de cosmoBots o una propia adaptada a tu organizacion).
102
4. Genera el documento: se creara una tabla de contenidos viva, se incrustaran las imagenes/diagramas ajustados para no salir de pagina y se autogeneraran los capitulos de referencias (documentos de referencia, aplicables y de conformidad) con sus matrices.
103
104
## Referencias documentales (csInfo/csRef)
105
- Items csInfo sirven para estructurar contenidos en arbol (capitulos/secciones) arrastrando otros items dentro (p.ej., un csInfo "Bugs pendientes" conteniendo bugs abiertos). Son clases de item (trackers) pensadas para visualizar el proyecto como un libro.
106
- Items csRef apuntan a referencias bibliograficas o documentales (wiki, documentos, URLs, ficheros, citas) y se clasifican como documentos de referencia, aplicables o de conformidad.
107
- Cada item puede tener un listado de csRef asociados en esas tres categorias.
108
- MainReport y los informes exportados generan automaticamente los capitulos de referencias y las matrices que relacionan los documentos de referencia con los items.
109
110
## Casos de uso ampliados
111
Historias de usuario o escenarios completos con inicio y fin. _Completar_
112
113
## Personalizacion y configuracion
114
Opciones de ajustes, plantillas y preferencias. _Completar_
115
116
## Integraciones
117
### Importacion/exportacion ODS de items
118
- Plantillas ODS (cosmoBots provee ejemplos) preparadas para crear/revisar items con:
119
  - Desplegables para seleccionar relaciones de dependencia y campos no libres.
120
  - Vistas de revision tipo DSM (Design Structure Matrix) o diagrama de bloques.
121
  - Refuerzos semanticos para resaltar la jerarquia de nodos.
122
  - Reglas de validacion (p.ej., columna "Asignado a" solo permite miembros del proyecto).
123
- Pestana `Dict` define los terminos y listas usadas en validaciones.
124
- Pestana adicional para que el usuario agregue nombres de columnas extra a importar/exportar.
125
- Plantilla troncal disponible; se pueden aportar plantillas propias adaptadas.
126
127
### Herramientas de administracion y automatizacion
128
- Script de carga masiva que toma una WBS (paquetes de trabajo) de uno o varios proyectos grandes y genera la arquitectura en una o varias familias de proyecto.
129
- Hoja de carga con refuerzos visuales/semanticos para definir equipos, entregables y responsables de cada proyecto y entregable.
130
- El script crea tareas de kick-off, desarrollo y cierre, enlazadas con dependencias fin-inicio y asignadas a sus responsables.
131
- Script de carga de tareas desde plantilla: a partir de una tabla con tareas, estimaciones, asignados y relaciones, permite que el equipo revise dependencias, reorganice y vea carga de trabajo en la propia hoja. Luego crea las tareas en el proyecto, asigna, categoriza y aplica relaciones.
132
- Estas dos herramientas (hojas de calculo semanticas + scripts) facilitan levantar estructuras de proyectos o cargar un proyecto consensuado desde hojas de calculo.
133
134
## Resolucion de problemas
135
- Sintoma: _Completar_ → Solucion: _Completar_
136
- Sintoma: _Completar_ → Solucion: _Completar_
137
138
## Preguntas frecuentes
139
- _Pregunta frecuente_ → _Respuesta_
140
141
## Referencia rapida
142
Tabla o listado de atajos, comandos o botones clave. _Completar_
143
144
## Seguridad y buenas practicas
145
- cosmoBots no asume responsabilidad sobre la seguridad del servidor cosmoSys ni de su contenido: se recomienda instalarlo en intranet o bajo VPN de la organizacion y combinarlo con una politica de respaldos.
146
- La organizacion debe decidir el equilibrio entre proteccion y facilidad de acceso para su equipo.
147
- Existen terceros (normalmente empresas) que pueden ofrecer alojamiento y mantenimiento con garantias de seguridad; evalue esas opciones si no hay infraestructura propia.
148
149
## Soporte y escalamiento
150
- Instancia publica para tickets de cosmoSys (bugs y desarrollo): https://support.csys.cosmobots.eu/projects/csys-issues/issues
151
- Canales de reporte: chat de soporte en Telegram; email de soporte de cosmoBots; o solicitud de usuario para reportar directamente en la instancia.
152
- _Completar con horarios/SLA/contactos especificos si aplican._
153
154
## Bitacora de cambios
155
- Version _X.Y_: _Resumen de cambios_
156
157
## Apendices
158
Material extra: glosario, formatos de archivo, plantillas de ejemplo. _Completar_
Go to top