Ohjelmistoarkkitehtuuri: Ohjelmistomallien viittaus

Aina kun kirjoitat asiakirjaa ja haluat viitata ohjelmistomalliin, varmista, että annat lukijoillesi tarpeeksi tietoa, jotta he voivat löytää saman mallin itse. Ohjelmistomallit näkyvät kirjoissa, aikakauslehdissä ja konferenssijulkaisuissa, ja niitä tulee lainata aivan kuten mitä tahansa muuta. Tässä on joitain ohjeita:

• Laita nimi pois. Tee asiakirjan rungossa kuvion nimi jollain tavalla erilaiselta kuin normaali teksti. Yleensä kuvion tekijät tekevät tämän käyttämällä pienten kirjainten muotoilua, alleviivaamalla kuvion otsikon tai kirjoittamalla sen johdonmukaisesti isoilla kirjaimilla.

• Merkitse kuvio. Merkitse kuvio niin, että lukijat löytävät koko kaavan yksityiskohtaisen viitteen kautta. Käytä mitä tahansa viittausmenetelmää, jota käytät asiakirjan muussa osassa – alaviitteet, loppuviitteet tai tekstin sisäinen teksti (teksti suluissa).

• Mainitse kaikki lähteesi. Sisällytä jokaiseen kaavaviitteeseen kaikki tyypillinen viitemateriaali, kuten kirjoittaja, mallin nimi ja se, mistä löysit kuvion (kuten kirja tai verkkosivusto). Joskus tarpeeksi ihmiset tuntevat viitteen, jotta voit käyttää lyhennettä.

• Päivää versio. Mainitse aina käyttämäsi malliversion päivämäärä, varsinkin jos lähdettäsi voidaan muuttaa ja päivittää. Esimerkiksi verkkosivujen kuviot voidaan päivittää helposti. Koska kuvioiden kirjoittaminen on loputon prosessi, kuvioita jalostetaan jatkuvasti, ja kuvioiden tekijät ilmoittavat uuden päivämäärän jokaiselle uudelle versiolle.