Requisitos
Generación de documentos
Inserte en los documentos matrices de trazabilidad, verificación e interfaces y informes de prueba en vivo, expórtelos en cuatro formatos, genérelos a partir de una línea base y márquelos: un aviso de la empresa, una declaración de distribución del DoD, un aviso de control de exportaciones, un copyright o un número de contrato en cada página y exportación.
En esta página
- Resumen
- Conceptos
- Cómo usarlo
- Insertar una matriz en un documento
- Exportar una matriz
- Matrices a partir de una línea base
- Informes de pruebas
- Marcar documentos y exportaciones
- Definir el marcado del proyecto
- Definir el marcado de la organización
- Dar a un documento su propio marcado, una portada y números de página
- Dónde se imprimen los marcados
- Comprobaciones del modelo
- Consejos
Resumen
Holarch genera los entregables a partir del modelo, de modo que un documento siempre coincide con los requisitos, las pruebas y los vínculos que hay detrás. Tres herramientas cubren lo que los revisores suelen pedir:
- Bloques de matriz: una matriz de trazabilidad, de verificación o de interfaces, o un informe de pruebas, dentro del texto de un documento, que se actualiza cada vez que cambia el modelo.
- Exportar matriz: las mismas matrices y el Informe de pruebas como archivo propio en Excel, Word, CSV o página web, a partir del modelo actual o de una línea base.
- Marcados y Configurar página: un marcado para la organización, el proyecto o un documento (un aviso de la empresa, una declaración de distribución, un aviso de control de exportaciones, un copyright o un número de contrato) en cada exportación, además de una portada y números de página para Word.
Los valores y las tablas en vivo dentro del texto se tratan en la página Documentos: Valor en vivo… inserta un atributo de una entidad, Recuento o total… un número calculado a partir de una consulta, Tabla en vivo… una tabla a partir de una consulta y Referencia cruzada… el número actual de una sección, una figura o una tabla.
Conceptos
Las matrices
| Matriz | Filas | Columnas | Resaltado como hueco |
|---|---|---|---|
| RTM (matriz de trazabilidad de requisitos) | Requisitos | Número, Requisito, Padre, Traced From, Traced To, Satisfied By | Un requisito sin padre y sin nada de lo que proceda su traza |
| Matriz de derivación descendente de requisitos | Requisitos | Número, Requisito, Deriva de, Deriva hacia, Requisitos derivados | Un requisito de nivel superior sin hijos ni requisitos derivados |
| Matriz de asignación de requisitos | Requisitos | Número, Requisito, Componentes, Funciones, Otros | Un requisito que nada satisface |
| Matriz de cumplimiento (se muestra cuando el programa formal está activado) | Requisitos de una especificación del cliente | Número, Requisito, Cumplimiento, Respuesta, Nuestros requisitos y diseño, Verificación, Desviación/Exención | Un requisito sin declaración de cumplimiento (No evaluado) |
| RVTM (matriz de trazabilidad de la verificación de requisitos) | Requisitos | Número, Requisito, Método, Nivel, Verificado por, Estado | Sin método de verificación o sin caso de prueba que lo verifique |
| VCRM (matriz de referencias cruzadas de verificación) | Requisitos | Número, Requisito, Inspección, Análisis, Demostración, Prueba, Verificado por, Estado | No se ha elegido ningún método de verificación |
| VCRM por nivel de verificación | Requisitos | Número, Requisito, después I, A, D y T bajo cada nivel de verificación, Verificado por, Estado | Sin método de verificación o sin nivel de verificación |
| Informe de pruebas | Casos de prueba de un ciclo de pruebas | Número, Caso de prueba, Verifica, Estado, Resultado real, Ejecución | Un caso de prueba que no se superó en el ciclo |
| Matriz de asignación | Funciones (Actions) | Número, Función, Realizada por | Una función que ningún componente realiza |
| Matriz de interfaces | Componentes (Assets) | Los mismos componentes; una celda enumera los Conduits del componente de la fila al componente de la columna | Un componente sin ningún Conduit hacia los demás o desde ellos |
| Matriz N² | Funciones (Actions) | Las mismas funciones; una celda enumera los Input/Outputs que genera la función de la fila y recibe la función de la columna | Una función que no intercambia ninguna entrada ni salida |
| Matriz personalizada | Entidades de una consulta de búsqueda | Entidades de una segunda consulta; una celda nombra las relaciones entre ambas, o muestra X para una relación elegida | Una fila sin relación con ninguna columna |
- Padre es el requisito que la fila decomposes. Traced From, Traced To y Satisfied By enumeran las entidades relacionadas. En la matriz de derivación descendente, los Requisitos derivados son los requisitos con los que la fila tiene traces to.
- En la VCRM, una X marca cada método previsto; Estado es el resultado de verificación hasta el momento, agregado a partir de los casos de prueba como en el Centro de pruebas.
- En la VCRM por nivel de verificación, las columnas se agrupan por los niveles del atributo Nivel de verificación (Component, Subsystem, System). Una X aparece bajo el nivel del requisito y cada uno de sus métodos previstos.
- Los casos de prueba nunca se enumeran como funciones: las matrices de asignación y N² muestran las Actions que no son Test Cases.
- Ámbito: una matriz abarca las entidades de un documento (en el orden y con la numeración del documento), todas las partes de una compilación o todo el proyecto. La matriz de asignación usa las funciones del documento, o todas las funciones cuando el documento no tiene ninguna. Las matrices de interfaces y N² también pueden abarcar los hijos de un Asset o una Action, como hacen los diagramas I² y N²; para todo el proyecto enumeran los componentes o funciones que tienen un Conduit o un Input/Output, hasta 120. La matriz personalizada muestra hasta 2000 filas y 120 columnas.
- El bloque Informe de pruebas muestra un ciclo de pruebas de una suite de pruebas, o sus resultados actuales. Consulte Informes de pruebas.
En vivo, no copiadas
Un bloque de matriz solo guarda qué mostrar, no las filas. Cada vez que el documento se muestra o se exporta, Holarch reconstruye las filas a partir del modelo. El resultado se guarda en caché hasta el siguiente cambio, de modo que los proyectos grandes siguen siendo rápidos.
Cómo usarlo
Insertar una matriz en un documento
- Abra el documento y haga clic en la descripción del documento o de un elemento.
- En la barra de herramientas de texto enriquecido, abra + y elija Matriz….
- Elija la Matriz y el Ámbito. El ámbito empieza en el documento abierto.
- Para una Matriz personalizada, escriba las consultas de búsqueda de Filas y Columnas (por ejemplo
class:Requirementyclass:Asset), elija una Relación o deje Cualquier relación, y póngale un Título si lo desea. - Para un Informe de pruebas, elija la Suite de pruebas y el Ciclo de pruebas, o Resultados actuales.
Verá una vista previa. Se actualiza cada vez que cambia el modelo.
- Para una Matriz personalizada, escriba las consultas de búsqueda de Filas y Columnas (por ejemplo
- Haga clic en Insertar.
La matriz aparece en el texto con un contorno discontinuo. Su leyenda nombra la matriz, el ámbito y cuántas filas tienen huecos.
La matriz no se puede editar celda a celda; cambie el modelo en su lugar. Para quitarla, elimine la tabla en el editor como cualquier otro contenido.
Exportar una matriz
- En un documento, abra Entregar ▾ y elija Matriz de trazabilidad…. O elija Entregar ▾ → Todas las exportaciones… y elija Matriz de trazabilidad (Excel), (Word), (CSV) o (HTML).
- En Exportar matriz, elija la Matriz y el Ámbito y, en Exportar como, elija Matriz (Excel), Matriz (Word), Matriz (CSV) o Matriz (HTML).
- Opcional: en Modelo, elija una línea base en lugar de Modelo actual. La lista muestra las líneas base del proyecto y las del documento elegido.
La línea bajo los campos indica el número de filas y el número de filas con huecos.
- Haga clic en Exportar.
El aviso indica «Matriz exportada.» Los huecos se sombrean en rojo en Excel, Word y la página web. Las exportaciones a Word y a página web usan la Configuración de página del documento. En Word, las columnas de texto son anchas y las de métodos de verificación estrechas, con los encabezados I, A, D y T y una leyenda bajo la tabla (I = Inspection, A = Analysis, D = Demonstration, T = Test). Las matrices con más de cinco columnas usan una página horizontal. La VCRM por nivel tiene una segunda fila de encabezado con los niveles; las matrices de interfaces, N² y personalizadas sombrean los encabezados de fila y la diagonal.
Matrices a partir de una línea base
Un entregable firmado debe mostrar el modelo tal como estaba al crear la línea base, no como está hoy. Una matriz generada a partir de una línea base usa las entidades y las relaciones de la línea base, y su título termina con «(baseline name)».
- Exportar matriz: elija la línea base en Modelo.
- Una línea base del proyecto contiene todo el modelo, de modo que todas las matrices funcionan a partir de ella.
- Una línea base del documento contiene el documento, sus elementos y las entidades vinculadas a ellos. Las matrices de ese documento están completas. Una matriz que va más allá del documento (todo el proyecto, o una matriz de interfaces o N²) lleva la nota «Generada a partir de una línea base del documento, que solo contiene ese documento y las entidades vinculadas a él.»
Informes de pruebas
Un informe de pruebas da los resultados de un ciclo de pruebas: qué se probó, con qué configuración, qué se superó y qué falló, y qué requisitos verifica todo ello.
- En el Centro de pruebas, registre un ciclo de pruebas con Iniciar nuevo ciclo…. Escriba la Configuración / compilación y el Artículo de prueba (ambos empiezan con los valores registrados con más frecuencia en la ejecución).
- En la tarjeta de la suite, abra ⋯ y elija Informe de pruebas…. O abra ⋯ → Ciclos de pruebas… y haga clic en Informe… en un ciclo.
- En Exportar informe de pruebas, elija el Ciclo de pruebas y, en Exportar como, Informe de pruebas (Word), (Excel), (CSV) o (HTML), y haga clic en Exportar.
El informe de Word (el predeterminado) tiene estas secciones:
- Identification: suite de pruebas, ciclo de pruebas, cuándo se guardaron los resultados y cuándo se elaboró el informe.
- Test Environment and Configuration: configuración o compilación, artículo de prueba, probadores y fechas de ejecución.
- Summary of Results: recuentos por estado y el porcentaje de superación.
- Results by Test Case: una fila por caso de prueba.
- Detailed Results: para cada caso de prueba, el resultado esperado y el real, el probador, la fecha, la configuración, el artículo de prueba, el archivo de evidencia y los resultados de los pasos.
- Deviations and Open Issues: los casos de prueba fallidos y bloqueados con sus Issues vinculadas.
- Test Evidence: los archivos de evidencia registrados en el ciclo.
- Requirement Verification Status: los requisitos que verifica la suite, con su estado según los resultados de este ciclo.
Excel da tres hojas (Results, Steps, Requirements); CSV y la página web dan la tabla de resultados. Los resultados proceden del ciclo tal como se guardó, de modo que el informe no cambia después de restablecer la suite. Los nombres, los requisitos verificados y las Issues proceden del modelo actual. Los ciclos guardados antes de que se conservaran los resultados de los pasos y las evidencias muestran esos campos como «—».
Para poner la tabla de resultados en un documento, inserte un bloque de matriz Informe de pruebas (véase más arriba).
Marcar documentos y exportaciones
Un marcado es un texto que Holarch imprime en todo lo que exporta: un encabezado en la parte superior de cada página, un pie de página en la parte inferior de cada página y un aviso en la primera página. Defínalo una vez para el proyecto, o para la organización, y cada exportación lo llevará. Un documento puede sustituirlo por uno propio.
Nota: el servicio alojado (app.holarch.app) no puede contener información CUI, clasificada ni sujeta a control de exportaciones (Condiciones de uso). Allí la lista estándar omite las declaraciones de distribución B a F y el aviso de control de exportaciones, y no se guarda un marcado que nombre CUI, un nivel de clasificación (como SECRET//NOFORN), ITAR, EAR o el control de exportaciones, o las declaraciones de distribución B a F: «El servicio alojado de Holarch no puede contener información CUI, clasificada ni sujeta a control de exportaciones, así que este marcado no se puede usar aquí. Quítelo o use la aplicación de escritorio o una instalación autoalojada.» Los avisos de empresa como Company Confidential, Distribution Statement A, el copyright y los números de contrato siguen disponibles. Los marcados definidos antes de esta regla se conservan y se siguen imprimiendo; para cambiar uno, quite la parte restringida.
La aplicación de escritorio y las instalaciones autoalojadas ofrecen la lista completa y aceptan cualquier marcado. Los marcados son textos que usted elige; Holarch los imprime pero no impone normas de manipulación, y se aplican los controles propios de su organización. En todas las ediciones, un aviso de control de exportaciones en un marcado desactiva la IA para el proyecto.
La lista Marcado estándar rellena el texto por usted:
| Marcado estándar | Encabezado | Pie de página | Aviso |
|---|---|---|---|
| Propiedad de la empresa | COMPANY PROPRIETARY | COMPANY PROPRIETARY | Un aviso de propiedad que nombra la Empresa |
| Confidencial de la empresa | COMPANY CONFIDENTIAL | COMPANY CONFIDENTIAL | Un aviso de confidencialidad que nombra la Empresa |
| Distribution Statement A a F (B a F: solo en la aplicación de escritorio y autoalojada) | (ninguno) | DISTRIBUTION STATEMENT A to F | La redacción estándar del DoD para la declaración (DoDI 5230.24), con Motivo, Fecha de determinación y Oficina de control rellenados |
| Aviso de control de exportaciones (ITAR/EAR) (solo en la aplicación de escritorio y autoalojada) | (ninguno) | Export-controlled technical data. See the notice on the first page. | Una advertencia de que el documento puede contener datos técnicos sujetos a ITAR (22 CFR 120–130) o EAR (15 CFR 730–774) |
| Copyright | (ninguno) | © Año Titular de los derechos de autor. All rights reserved. | (ninguno) |
| Número de contrato | (ninguno) | Contract No. Número de contrato | (ninguno) |
Un campo que se deja vacío se queda en el texto como marcador entre corchetes, como [reason]. El editor muestra entonces «Complete las partes entre corchetes antes de exportar.»
Definir el marcado del proyecto
- Pulse ⌘K / Ctrl+K y elija Marcado del proyecto…. También puede abrirlo desde Configurar página… en un documento, o desde Preferencias del proyecto… (Inicio ▾ en Inicio) del proyecto abierto.
- Elija Marcado propio.
- En Marcado estándar, elija una entrada, rellene sus campos (por ejemplo Empresa) y haga clic en Añadir al marcado.
Verá rellenados el Encabezado, el Pie de página y el Aviso. Añada otra entrada para combinarlas: los encabezados y los pies se unen con « · » y cada aviso se convierte en su propio párrafo.
- Edite el texto si es necesario y haga clic en Guardar.
El aviso indica «Marcado del proyecto guardado.» Solo los propietarios del proyecto cambian el marcado del proyecto; los demás miembros lo ven en solo lectura.
Borrar vacía los tres campos. Sin marcado desactiva el marcado para el proyecto, también cuando la organización tiene uno.
Definir el marcado de la organización
- Abra el menú de la cuenta, elija Ajustes de la organización y abra la organización.
- En Marcado del documento, haga clic en Editar marcado….
- Defina el marcado como para un proyecto y haga clic en Guardar.
El aviso indica «Marcado de la organización guardado.» Se aplica a todos los proyectos de la organización que no tienen marcado propio. Solo los administradores de la organización lo cambian.
Dar a un documento su propio marcado, una portada y números de página
- En un documento, abra Entregar ▾ y elija Configurar página….
- En Marcado, elija una opción:
- Marcado del proyecto o de la organización (el predeterminado): la línea de debajo nombra el marcado que usa el documento.
- Marcado propio: defina el encabezado, el pie de página y el aviso como para un proyecto.
- Sin marcado: el documento y sus exportaciones no llevan ninguno.
- Rellene el resto:
- Portada, con Versión y Elaborado por. La portada también muestra el aviso.
- Números de página («Page X of Y») en las exportaciones a Word.
- Haga clic en Aplicar.
El aviso indica «Configuración de página guardada.» El encabezado y el pie de página aparecen en la parte superior e inferior del documento, y el aviso bajo su título. ⌘Z / Ctrl+Z deshace el cambio en un solo paso.
Gana el marcado más cercano: el propio del documento; si no, el del proyecto; si no, el de la organización.
Dónde se imprimen los marcados
- Vista de documento e Imprimir o PDF…: el encabezado y el pie de página en la parte superior e inferior de cada página, el aviso bajo el título.
- La exportación a Word (Entregar ▾ → {template} (Word), o Documento (Word) en Todas las exportaciones…): el encabezado y el pie de página se repiten en cada página, con números de página si se eligen, y la portada sustituye al título simple. Un bloque de matriz en vivo del documento se convierte en una tabla de Word con su título encima, los mismos anchos de columna y encabezados I/A/D/T, y sus huecos sombreados en rojo.
- Exportar matriz y Matriz de trazabilidad (Word) o (HTML).
- Otros archivos Word: el documento ICD y las exportaciones de presentación, de diagrama y Desglose (Word) llevan el encabezado y el pie en cada página y el aviso bajo el título.
- Informes de Excel: el encabezado y el pie van al encabezado y pie de página de cada hoja, que Excel muestra en la vista Diseño de página e imprime.
- CSV: solo cuando marca Marcado como primera línea en Tabla (CSV). Está desactivado de forma predeterminada, para que el archivo se pueda volver a importar tal cual.
- Imágenes de diagramas: las exportaciones PNG y SVG reciben una banda sobre el diagrama con el encabezado y otra debajo con el pie y el aviso. Las exportaciones Página web (HTML) los muestran en la parte superior e inferior de la página. Las miniaturas y las imágenes de diagramas dentro de documentos quedan sin marcar.
- Presentaciones: las diapositivas de PowerPoint, página web, PNG y SVG muestran el encabezado y el pie en cada diapositiva y el aviso en la primera.
- Una compilación tiene su propia Configuración de página, que se usa al exportar la compilación.
Comprobaciones del modelo
Las Comprobaciones del modelo informan de un valor en vivo o una tabla en vivo que apunta a algo eliminado (regla Global.7, «Valores en vivo que apuntan a destinos inexistentes»):
- Un Valor en vivo cuya entidad se ha eliminado muestra «{Entity: … Not found}».
- Un bloque de matriz cuyo documento de ámbito se ha eliminado, un bloque Informe de pruebas cuya suite o ciclo de pruebas se ha eliminado, o una Matriz personalizada cuya relación ya no existe.
- Un Recuento o total o una Tabla en vivo cuya consulta nombra una clase, etiqueta, relación o documento que no existe.
- Una Referencia cruzada cuyo elemento, figura o tabla se ha eliminado.
Abra la descripción y edite o quite el valor en vivo, o vuelva a insertarlo para un destino que exista. Consulte Comprobaciones del modelo.
Consejos
- Ponga la RVTM o la VCRM al final de una especificación como su sección de verificación; se mantiene al día hasta la revisión.
- Para un paquete de revisión, cree una compilación y dele una portada y un marcado en su propia Configuración de página.
- Exporte la VCRM a Excel para un comité de revisión que la anote, y conserve el bloque en vivo en el documento.
- Para un plan de verificación organizado por nivel de integración, use la VCRM por nivel de verificación y defina antes el Nivel de verificación de cada requisito.
- Para un documento de control de interfaces, inserte una Matriz de interfaces con el Asset del sistema como ámbito, de modo que sus hijos y sus Conduits aparezcan en la diagonal y en las celdas.