Improving hardware/software interface management in systems of systems through documentation as code

Abstract

Context: The management of Interface Control Documents (ICDs) has shown to be a major pain point in the architecting processes of Systems of Systems (SoS). Objective ThisworkaimstoimproveonpreviouslyidentifiedICDmanagementissuesusing the documentation-as-code philosophy as a potential basis for a treatment, and in collaboration with practitioners. Method: Weconducted a Technical Action Research (TAR) study with a group of engineers at the Netherlands Radio Astronomy Institute (ASTRON), in the context of the LOFAR radio telescope. An additional research instrument, in the form of an expert panel, was used to evaluate the transferability of the proposed treatment to alternative domains. Results: In-depth insights on previously identified interface management issues were gained. Based on these insights a functional proof-of-concept was developed aimed at addressing these issues following the documentation-as-code principles. In addition to receiving overall positive reviews from practitioners and experts, further areas of improvement and transferability considerations for future work were identified. Conclusions: The proposed approach, which to our knowledge has not been explored before in this context, is promising to address some of the recurring interfacing-related issues with directed SoS in multiple engineering domains. This could be done mainly by enforcing consistency and completeness on both text-based and formal elements of the ICDs, and turning ICDs into single sources of truth for the architecting processes of large scale SoS.

Contexto: La gestión de documentos de control de interfaz (ICD) ha demostrado ser un punto importante en los procesos de arquitectura de sistemas de sistemas (SoS). Objetivo Este trabajo tiene como objetivo mejorar los problemas de gestión de ICD previamente identificados utilizando la filosofía de documentación como código como base potencial para un tratamiento y en colaboración con los profesionales. Método: Llevamos a cabo un estudio de Investigación de Acción Técnica (TAR) con un grupo de ingenieros del Instituto de Radioastronomía de los Países Bajos (ASTRON), en el contexto del radiotelescopio LOFAR. Se utilizó un instrumento de investigación adicional, en forma de un panel de expertos, para evaluar la transferibilidad del tratamiento propuesto a dominios alternativos. Resultados: Se obtuvieron conocimientos profundos sobre problemas de gestión de interfaces previamente identificados. Sobre la base de estos conocimientos, se desarrolló una prueba de concepto funcional destinada a abordar estos problemas siguiendo los principios de documentación como código. Además de recibir críticas positivas en general de profesionales y expertos, se identificaron otras áreas de mejora y consideraciones de transferibilidad para trabajos futuros. Conclusiones: El enfoque propuesto, que hasta donde sabemos no se ha explorado antes en este contexto, promete abordar algunos de los problemas recurrentes relacionados con la interfaz con SoS dirigido en múltiples dominios de ingeniería. Esto podría lograrse principalmente imponiendo coherencia e integridad a los elementos formales y basados ​​en texto de los ICD, y convirtiendo los ICD en fuentes únicas de verdad para los procesos de arquitectura de SoS a gran escala.