From Reflections to Systems Thinking : Developing a Practice for Documenting Software Architecture in a Growth Company
Suni, Jari (2020)
Suni, Jari
2020
All rights reserved. This publication is copyrighted. You may download, display and print it for Your own personal use. Commercial use is prohibited.
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-2020052513290
https://urn.fi/URN:NBN:fi:amk-2020052513290
Tiivistelmä
Toimeksiantaja, Woolman-yhtiö, havaitsi, että ilman arkkitehtuuridokumentaatiota projekti- ja tuotekehitys olivat vaikeuksissa. Arkkitehtuurin dokumentointi oli liiketoimintakriittistä erityisesti siirtymävaiheissa: myynnistä toteutukseen ja projekteista jatkuviin palveluihin. Tavoitteena oli kehittää yhteinen käytäntö ohjelmistoarkkitehtuurin dokumentoimiseksi yrityksessä. Arkkitehtuuridokumentaatiota tutkittiin iteraatioissa, ja teoriaa sovellettiin käytäntöön kokeilujen kautta. Tavoitteena oli ymmärtää arkkitehtuurityön ydin liiketoimintaympäristössä: milloin arkkitehtuuridokumentti tulisi tuottaa, mitä tulisi dokumentoida ja miten.
Tutkimuksessa käytettiin päiväkirjamenetelmää, jolla kuvattiin työtä, ajattelua, ongelmanratkaisua ja oppimista. Laadullisen tutkimuksen aineistoa kerättiin päivittäin, ja sitä seurasi viikoittainen analyysi. Raportointijakso oli seitsemän viikkoa kalenteriaikana.
Tulokset osoittavat, että kaiken kattavaa arkkitehtuurinäkymää ei kannata tavoitella. Sen sijaan ongelmaa on tarkasteltava systemaattisesti eri näkökulmista käyttämällä useita arkkitehtuurityylejä. Jotta voidaan valita sopiva joukko näkymiä, on ensin yksilöitävä sidosryhmät, jotka dokumentaatiota tarvitsevat, ja ymmärrettävä kunkin sidosryhmän tietotarpeet. Jokaisella arkkitehtuurityylillä on erilainen arvo riippuen katsojan kontekstista. Eri tyylien tutkiminen ja soveltaminen käytännön työhön paransivat tekijän ammattitaitoa. Myös yrityksen dokumentointiprosesseissa saavutettiin suurta kehitystä. Näitä tutkimuksessa kuvattuja uusia toimintamalleja voidaan soveltaa missä tahansa kasvuyrityksessä tai tiimissä. It was identified by the assigner, Woolman company, that without architecture documentation the project and product development efforts struggled. Architecture documentation was business critical when proceeded from one phase to another: from sales to implementation and from projects to continuous services. The goal of the author was to develop a common practice for documenting software architecture in the company. The author studied architecture documentation in iterations and brought theory to practice through experimentation. The focus was to understand the essence of architecture work in the actual business context: when an architecture document should be produced, what should be documented and how.
The author used a diary-based method where he described his work and reflected his thinking, problem-solving, and learning. The relevant data for the qualitative research was gathered on a daily basis and followed up by a weekly reflective summary. The reporting period covered seven weeks in calendar time.
The results show that an all-encompassing architecture view is not worth pursuing. Instead, the problem needs to be systematically viewed from different perspectives using different architecture styles. To choose the appropriate set of views, one must identify the stakeholders that will depend on the documentation and understand each stakeholder’s informational needs. Each architecture style has a different value depending on the viewer’s context. Researching different architecture styles and applying them to practical work improved the author ́s professional competence. Great development was made in the company ́s documenting processes as well. These new operation modes described in the research can be used in any growth company or team.
Tutkimuksessa käytettiin päiväkirjamenetelmää, jolla kuvattiin työtä, ajattelua, ongelmanratkaisua ja oppimista. Laadullisen tutkimuksen aineistoa kerättiin päivittäin, ja sitä seurasi viikoittainen analyysi. Raportointijakso oli seitsemän viikkoa kalenteriaikana.
Tulokset osoittavat, että kaiken kattavaa arkkitehtuurinäkymää ei kannata tavoitella. Sen sijaan ongelmaa on tarkasteltava systemaattisesti eri näkökulmista käyttämällä useita arkkitehtuurityylejä. Jotta voidaan valita sopiva joukko näkymiä, on ensin yksilöitävä sidosryhmät, jotka dokumentaatiota tarvitsevat, ja ymmärrettävä kunkin sidosryhmän tietotarpeet. Jokaisella arkkitehtuurityylillä on erilainen arvo riippuen katsojan kontekstista. Eri tyylien tutkiminen ja soveltaminen käytännön työhön paransivat tekijän ammattitaitoa. Myös yrityksen dokumentointiprosesseissa saavutettiin suurta kehitystä. Näitä tutkimuksessa kuvattuja uusia toimintamalleja voidaan soveltaa missä tahansa kasvuyrityksessä tai tiimissä.
The author used a diary-based method where he described his work and reflected his thinking, problem-solving, and learning. The relevant data for the qualitative research was gathered on a daily basis and followed up by a weekly reflective summary. The reporting period covered seven weeks in calendar time.
The results show that an all-encompassing architecture view is not worth pursuing. Instead, the problem needs to be systematically viewed from different perspectives using different architecture styles. To choose the appropriate set of views, one must identify the stakeholders that will depend on the documentation and understand each stakeholder’s informational needs. Each architecture style has a different value depending on the viewer’s context. Researching different architecture styles and applying them to practical work improved the author ́s professional competence. Great development was made in the company ́s documenting processes as well. These new operation modes described in the research can be used in any growth company or team.