Ehdotus TKK:n WWW-dokumenttien rakenteeksi

Johdanto

Suositus koskisi ensi sijassa ns. virallisia sivuja, jotka ovat TKK:n jonkin yksikön tuottamia ja joiden sisällöstä viime kädessä päättää ja vastaa yksikön johtaja. Monia suosituksen periaatteita voitaisiin soveltaa myös henkilökohtaisiin kotisivuihin ja niiden takana oleviin sivuihin, mutta niistä olisi syytä tehdä erikseen tarkempi suositus.

Ehdotus on tarkoitettu keskustelun pohjaksi.

Luonnollisestikin tämä dokumentti on pyritty laatimaan esimerkiksi sen sisältämän suosituksen noudattamisesta.

Tavoitteet

• tarjota tietoa korkeakoulusta ja sen toiminnasta kaikille siitä kiinnostuneille tahoille kuten
  • niille, jotka ovat tutkimusyhteistyössä TKK:n kanssa tai siitä kiinnostuneita
  • TKK:sta opiskelupaikkana kiinnostuneille
  • valtionhallinnolle
• tarjota TKK:n opiskelijoille ja henkilökunnalle tietoa korkeakoulun toiminnasta sekä antaa heille tukea tiedon etsintään WWW:stä.

Näitä tavoitteita toteuttamisessa tulee pyrkiä ennen muuta tiedon oikeellisuuteen ja ajantasaisuuteen. Tämä merkitsee sitä, että harkittaessa tiedon tuottamista WWW:hen on erityisesti arvioitava, missä määrin ollaan valmiit ylläpitämään tietoja jatkuvasti.

Erityisesti tarjottaessa tietoja TKK:n ulkopuolisille on otettava huomioon, että WWW toimii myös mainonnan välineenä esimerkiksi kerrottaessa TKK:n maksullisesta palvelutoiminnasta siitä kiinnostuneille tahoille. Tämä edellyttää asianmukaisen huomion kiinnittämistä WWW-sivujen visuaaliseen ilmeeseen, mutta tämä ei saa merkitä tietojen rakenteen hämärtymistä.

WWW-dokumenttien luokitus ja ylläpitovastuu

1. Koko korkeakoulua koskevat dokumentit kuten TKK:n kotisivu ja opetusta, tutkimusta ja hallintoa yleisesti kuvaavat dokumentit. Näiden ylläpidon hoitaa korkeakoulun tiedotusyksikkö.
2. Korkeakoulun laboratorioiden ja muiden yksiköiden viralliset dokumentit. Niistä päättää ja vastaa yksikön johtaja. Kussakin yksikössä tulee määritellä, ketkä tuottavat ja ylläpitävät kyseisiä dokumentteja, ja huolehtia tehtävien siirrosta henkilökunnan vaihtuessa.
3. Korkeakoulun työntekijöiden kotisivut. Näiden tulisi ensisijaisesti kertoa asianomaisen henkilö- ja yhteystiedot sekä hänen tehtäväalueestaan ja ajankohtaisista hankkeista (esim. tutkimusprojekteista, joihin hän osallistuu). Mukana voi, oman harkinnan mukaan, olla valokuva, joka helpottaa tunnistamista. Henkilökohtaisemmat tiedot kuten tiedot harrastuksista on suositeltavaa sijoittaa erillisille sivuille, joihin on linkit kotisivulta. Jokainen vastaa omasta kotisivustaan, mutta yksiköt voivat antaa henkilökunnalleen tarkempia määräyksiä kotisivujen sisällöstä.
4. Muut dokumentit. Nämä ovat tekijöidensä vastuulla.

Atk-keskus antaa tarvittaessa teknistä apua dokumenttien ylläpitoon. Tämä ei kuitenkaan normaalisti tarkoita tietojen siirtämistä tai WWW-sivujen tekemistä yksiköille vaan niihin soveltuvien apuvälineiden tarjoamista ja esiin tulevien ongelmien ratkomista. Yleisiä ohjeita löytyy osoitteen http://www.hut.fi/WWW/ kautta, ja ohjeita erityisesti virallisen tiedon tuottajille osoitteesta
http://www.hut.fi/WWW/Tuottajat/

WWW-dokumenttien toteutus

Käytännössä tämä merkitsee tällä hetkellä sitä, että normaalisti dokumentit kirjoitetaan HTML 2.0:n mukaisesti. Sen tarjoamat mahdollisuudet riittävät useimpiin käytännön tarpeisiin kohtuullisesti, ja lähes kaikki katseluohjelmat tukevat sen mukaisia rakenteita. HTML 2.0:n virallisin määrittely on RFC 1866 mutta käytännön työssä sopivampia kuvauksia siitä ovat esimerkiksi seuraavat:

• NCSA:n A Beginner's Guide to HTML, joka kuvaa HTML 2.0:n lisäksi eräitä yleisesti toteutettuja laajennuksia
• Sandia National Laboratories: HTML Reference Manual, joka kuvaa myös lukuisia HTML 2.0:aan kuulumattomia rakenteita mutta selostaa kunkin rakenteen aseman eri HTML-määrittelyissä.

Erityisen perustellusta syystä voidaan käyttää uudempia, kehittelyasteella olevia rakenteita. Esimerkiksi taulukkomuotoisen tiedon esittämisessä voi table-rakenne joskus olla ratkaisevasti parempi kuin mikään HTML 2.0:n tarjoama tapa. Tällöinkin on pyrittävä käyttämään vain yleisesti tuettuja rakenteita ja mahdollisuuksien mukaan tarjottava tieto myös vaihtoehtoisessa, HTML 2.0:n mukaisessa muodossa. Erilaiset tekstityypit tulisi esittää ns. loogisilla tyyleillä (esim. cite, joka tarkoittaa yleisesti sitaattia, ei i, joka tarkoittaa kursivoitua kirjasinlajia), ellei ole asiasisällön kannalta olennaista, että teksti on nimenomaan määrätynlaisella kirjasinlajilla esitetty.

WWW-dokumentin tulisi olla kohtuullisen kokoinen. Esimerkiksi laajat raportit ja muistiot on pyrittävä jakamaan pienempiin osiin, joihin pääsee käsiksi sisällysluettelodokumentin kautta. Erityisesti on vältettävä suurien kuvien käyttöä dokumentteihin upotettuina. Kuva-aineisto on parasta tarjota siten, että tietojen katselija voi itse päättää, mitä kuvia hän valitsee katsottavakseen; tällöin siis lähinnä tekstiä sisältävässä dokumentissa on linkkejä kuviin siten, että linkkeihin liittyy selittävä teksti kuvan luonteesta. Edellä sanottu ei koske sellaisia esittelyaineistoja, jotka on nimenomaisesti tarkoitettu katseltavaksi grafiikkaa hyvin tukevassa ympäristössä; esitettäessä linkkejä tällaisiin aineistoihin on syytä tuoda esiin niiden luonne.

WWW-dokumentissa tulisi aina olla

• title-rakenne, jossa on selkeä nimi dokumentille; sitä valittaessa on pyrittävä siihen, että dokumentin luonne on tunnistettavissa siitä asiayhteyttä tuntemattakin
• määrittely, joka kertoo dokumentin vanhentumisen (expiration) ajankohdan; tämä ajankohta tulisi valita sen mukaan, milloin dokumentin sisältö oletettavasti olisi viimeistään tarkistettava
• sopivalla tavalla, esim. h1-rakenteella, toteutettu dokumentin näkyvä otsikko
• tieto dokumentin vastuuhenkilöstä
• tieto dokumentin viimeisimmän päivityksen ajankohdasta
• tieto dokumentin osoitteesta (URL); tämä on tarpeeksi siksi, että kun dokumentti on tulostettu paperille, sen alkuperä selviää tulosteesta.

Suositeltava WWW-dokumentin perusrakenne on seuraava:

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<HTML>
<HEAD>
<TITLE>Otsikko</TITLE>
<LINK REV="MADE" HREF="mailto:sähköpostiosoite">
<META HTTP-EQUIV="Expires" CONTENT="1.9.1996">
</HEAD>
<BODY>
<h1>Otsikko</h1>
Tähän tulee dokumentin varsinainen sisältö.
<hr>
<em>
Tämän sivun sisällöstä vastaa 
<A HREF="kotisivu">nimi,
E-mail: <a href="mailto:sähköpostiosoite">sähköpostiosoite</a><br>
Sivua on viimeksi päivitetty päiväys.<br>
URL: URL
</em>
</BODY>
</HTML>

• korkeakoulun virallisten dokumenttien alkuun teksti, lyhenne tai kuva, joka kertoo, että kyse on nimenomaan TKK:n aineistosta, sekä tarvittaessa tarkentava tieto laboratoriosta; näihin tietoihin on syytä liittää linkit TKK:n kotisivulle ja asianomaisen yksikön kotisivulle; esimerkki:

  <a href="http://www.hut.fi/">Teknillinen korkeakoulu</a>,
  <a href="http://www.hut.fi/TKK/ATK/">atk-keskus</a>
  

• muistioihin, luonnoksiin ja vastaaviin dokumentteihin sopiva selostus, joka tuo niiden aseman esiin, esim. sanan muistio tai luonnos tai ehdotus
• korkeakoulun henkilökunnan kotisivuille tieto siitä, että kyse on TKK:n työntekijän kotisivusta.

Dokumenttien sisällöstä

• dokumentin asiasisältö on oikea ja pidetään ajan tasalla
• dokumentin tarjoaminen yleisesti luettavaksi palvelee korkeakoulun tehtäviä; vaikka epävirallisilla sivuilla sallitaan monentyyppistä aineistoa, niin on kiellettyä käyttää korkeakoulun resursseja korkeakoulun ulkopuolisiin kaupallisiin tarkoituksiin tai korkeakouluun liittymättömien yhdistysten ja muiden organisaatioiden tiedotustoimintaan
• dokumentin sisällön pitäminen yleisesti luettavissa on laillista; tällöin on otettava huomioon mm. tekijänoikeuslain ja henkilörekisterilain säädökset sekä asiakirjojen julkisuuden rajoitukset.