Arkkitehtuurien dokumentointi

• + - 0. Yleinen
  • Valitse näkymät
  • Dokumentoi näkymät
  • Dokumentoi näkymille yhteiset asiat
  • Lähde: Bass et al., myös hyvä lienee Clements et al. 2003 Doc. SAs
• + - 1. Näkymät
  • + - 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
  • + - 4+1
    • 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
  • + - 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
    • Yhdistä näkymät, joissa on vähän informaatiota tai samaa informaatiota
    • Priorisoi näkymät
  • + - Näkymän dokumentointi
    • 1. Primääri kuvaus: UML/laatikot-ja-viivat, tai tekstuaalinen
    • + - 2. Elementtiluettelo
      • Elementit ja niiden ominaisuudet
      • Suhteet ja niiden ominaisuudet
      • + - Elementtien rajapinnat
        • Rajapinnan identiteetti
        • + - Tarjoama
          • Syntaksi
          • Semantiikka
          • Käyttörajoitukset
          • CORBA IDL
        • Tietotyyppien määrittelyt
        • Poikkeusten määritelmät
        • Mukautuvuus, konfiguroitavuus
        • Laatuatribuuttien näkyvyys
        • Elementin tarpeet
        • Tarkoitus ja suunnittelun motivaatiot
        • Käyttöopas
      • Elementtien käytös
    • 3. Kontekstidiagrammi
    • 4. Mukauttamisopas
    • + - 5. Arkkitehtuurin taustatiedot
      • Miksi ko. arkkitehtuuri tehty/valittu?
      • Tulosten analysointi
      • Oletukset
    • 6. Termistö
    • 7. Muuta tarvittavaa tietoa
  • + - Yhteiset asiat
    • + - Miten organisoitu (rakenne)
      • Näkymäluettelo
      • Näkymämalli
    • + - Mitä
      • Järjestelmän yleiskuva
      • Miten näkymät liittyvät toisiinsa
      • Lista elementeistä ja missä niiden esiintymistä
      • 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 :)