Arkkitehtuurien dokumentointi

• + - 0. Yleinen
  • ~ http://www.sei.cmu.edu/ata/C4ISR_03/C4ISR_03_4.htm
  • Vaiheet
    • Valitse näkymät
    • Dokumentoi näkymät
    • Dokumentoi näkymille yhteiset asiat
  • + - Dokumentoi 'mitä' ja 'miksi', älä 'miten'.
    • 'Miten' on jo suunnittelua.
  • Lähde: Bass et al., tarkemmin Clements et al. 2003 Doc. SAs
  • ~ http://www.sei.cmu.edu/architecture/arch_doc.html
  • ~ http://www.sei.cmu.edu/ata/C4ISR_03/C4ISR_03_1.htm
• 1. Näkymät
  • ~ http://www.sei.cmu.edu/ata/C4ISR_03/C4ISR_03_9.htm
  • + - Moduuli (module)
    • + - Rakenne, hajotus (decomposition)
      • "on alimoduuli"
    • + - Käyttö (uses)
      • "vaatii läsnäolon"
      • + - kerros (layered)
        • "käyttää palveluita; abstrahoi"
    • + - Luokka, yleistys (class, generalisation)
      • "esiintymä; periytyy"
  • + - Komponentti ja kytkentä (component-and-connector)
    • + - asiakas-palvelin
      • "kommunikoi; riippuvainen"
    • + - yht'aikaisuus (concurrency)
      • "sama looginen säie"
    • + - prosessi
      • "yht'aikaisuus; estää; edeltää"
    • + - jaettu data
      • "tuottaa/kuluttaa dataa"
  • + - Varaus (allocation)
    • työnjako
    • + - sijoitus (deployment)
      • missä elementtiä ajetaan
    • + - toteutus (implementation)
      • missä tiedostossa elementti on
  • ~ http://www.sei.cmu.edu/ata/C4ISR_03/C4ISR_03_17.htm
  • + - Vaihtoehtona 4+1
    • ~ http://www.sei.cmu.edu/ata/C4ISR_03/C4ISR_03_10.htm
    • looginen -- moduuli
    • prosessi -- komponentti ja kytkentä
    • kehitys -- varaus
    • fyysinen -- varaus
    • Kruchten 1995, The 4+1 View Model of Architecture, IEEE Software, vol 12, no 6, Nov 1995
• 2. Näkymien dokumentointi
  • ~ http://www.sei.cmu.edu/ata/C4ISR_03/C4ISR_03_13.htm
  • + - Osalliset
    • Asiakasta edustava arkkitehti ja vaatimussuunnittelija
    • Arkkitehdit ja suunnittelijat
    • Toteuttajat
    • Testaajat ja integroijat
    • Ylläpitäjät
    • Muiden yhteistyöjärjestelmien tekijät
    • Laatuatribuuttiasiantuntijat
    • Johtajat
    • Tuotelinjajohtajat
    • Laadunvarmentajat
  • + - Näkymien valinta
    • + - Tee taulukko, joka kertoo kuinka tärkeä kukin näkymä on kullekin osalliselle
      • Näkymät sarakkeisiin
      • Osalliset riveille
      • Arvioi kunkin näkymän arvo jokaiselle osalliselle.
    • Yhdistä näkymät, joissa on vähän informaatiota tai samaa informaatiota
    • Priorisoi näkymät
    • ~ http://www.sei.cmu.edu/ata/C4ISR_03/C4ISR_03_27.htm
  • + - Näkymän dokumentointi
    • ~ http://www.sei.cmu.edu/ata/C4ISR_03/C4ISR_03_28.htm
    • 1. Primääri kuvaus: UML/laatikot-ja-viivat, tai tekstuaalinen
    • + - 2. Elementtiluettelo
      • Elementit ja niiden ominaisuudet
      • Suhteet ja niiden ominaisuudet
      • + - Elementtien rajapinnat
        • Määritelmä:
          • Rajapinta on se raja, jonka läpi kaksi
            erillistä elementtiä liittyy, toimii tai kommunikoi.
        • Keskity elementin kanssakäyntiin toiminnallisen
          ympäristön kanssa, älä toteutukseen.
        • Varo päällekkäisyyksiä komponentti ja kytkentä -näkymien kanssa.
        • Muotti
          • + - Rajapinnan identiteetti
            • kaikille rajapinnoille
            • nimi, versio
          • + - Resurssien tarjonta
            • Syntaksi
              • nimi
              • parametrien järjestys, nimet, tyypit
              • parametrien suunta: sisään, ulos, molemmat
            • Semantiikka
              • + - arvojen sijoitus käyttäjän käytettävissä oleviin paikkoihin
                • paluuarvo
                • tietokanta
              • tapahtumat, viestit
              • kuinka muut resurssit toimivat tämän resurssin käytön jälkeen, vrt. "tuhoa olio"
              • ihmisen huomaamat toiminnan tulokset
            • Käyttörajoitukset
              • yhtäaikaisten käyttäjien määrä
              • käyttöoikeudet, -rajoitukset
            • CORBA IDL
          • + - Tietotyyppien määrittelyt
            • kielen ulkopuoliset tyypit dokumentoitava
            • kuinka esitellään muuttujia ja vakioita
            • kuinka kirjoitetaan literaalit
            • mitä operaatioita ja vertailuja käytettävissä
            • kuinka muuntaa arvot toisentyyppisksi
          • Poikkeusten määritelmät
          • Mukautuvuus, konfiguroitavuus
          • Laatuatribuuttien näkyvyys
          • + - Elementin tarpeet
            • kuten 'Resurssien tarjonta'
          • + - Tarkoitus ja suunnittelun motivaatiot
            • perustelut
            • vaihtoehdot
          • + - Käyttöopas
            • protokolla
      • + - Elementtien käytös
        • elementille, tai elementtien yhteistoiminnalliselle joukolle
        • + - kertoo
          • elementtien välisten toimintojen järjestyksestä
          • toimintojen samanaikaisuuden mahdollisuuksista
          • toiminnallisuuden aikavaateista
        • + - UML
          • sekvenssikaaviot
          • tilakaaviot
          • ???
    • 3. Kontekstidiagrammi
    • 4. Mukauttamisopas
    • + - 5. Arkkitehtuurin taustatiedot
      • Miksi ko. arkkitehtuuri tehty/valittu?
      • Tulosten analysointi
      • Oletukset, jotka heijastuvat arkkitehtuurista
    • 6. Termistö
    • 7. Muuta tarvittavaa tietoa
  • + - Yhteiset asiat
    • ~ http://www.sei.cmu.edu/ata/C4ISR_03/C4ISR_03_34.htm
    • + - Miten organisoitu (rakenne)
      • Näkymäluettelo
      • Näkymämalli
    • + - Mitä
      • Järjestelmän yleiskuva
      • Miten näkymät liittyvät toisiinsa
      • Lista elementeistä ja mistä niiden esiintymät löytyvät
      • Projektisanasto
    • + - Miksi tulos on sellainen kuin on
      • Miksi ei?
• 3. Muu dokumentaatio
• 4. UML:stäkö apua
• + - 5. Muuta?
  • + - Hatley et al.

    • (:vertical "ui processing" (:horizontal "input processing" (:vertical "main functions" "support prosessing") "output processing"))

  • Zachman
  • Etnologia :)