Tekninen dokumentointi. Osa 1: Informaation jäsentely, dokumenttien luokittelu ja dokumenttien hallinta
Technical documentation. Part 1: Structuring of information, classification of documents and document management
1. painos. Kesäkuu 2006. A4-koko. 221 sivua
ISBN 952-5650-05-7
Tiivistelmä
Tämä sähkö- ja elektroniikka-alan standardisoimisjärjestö SESKO ry:n valmistelema uusi SFS-käsikirja 174-1 käsittelee dokumenttien luokittelua, informaation jäsentelyä ja dokumenttien hallintaa.
Käsikirjaan on koottu yhteen kaikki käsikirjan otsikkoon liittyvät kansainväliset standardit, jotka on laadittu IEC:n komiteassa TC 3 Information structures, documentation and graphical symbols.
Dokumentoinnin standardit on perinteisesti laadittu kansainvälisten standardisointiorganisaatioiden komiteoissa siten, että IEC TC 3 ja sen alakomiteat SC 3C ja SC 3D ovat laatineet sähkötekniikkaan liittyvät standardit ja ISOn komiteat muun tekniikan alueen dokumentointistandardit. Maailman muuttuessa eri tekniikan alueiden rajat ovat hämärtyneet, ja yksittäisen standardin soveltamisala on laajentunut suppeasta alueesta yleiseksi. Tästä johtuen ISOn ja IEC:n standardisointityötä tehdään yhä enemmän yhdessä.
Edellä mainitusta kehityksestä johtuen tämän käsikirjan otsikoksi on valittu sähköteknisen dokumentoinnin sijasta tekninen dokumentointi.
Tämä käsikirja julkaistaan kahdessa eri muodossa: perinteisenä painettuna käsikirjana ja sähköisenä e-käsikirjana. Painetussa versiossa on mukana vain standardien suomenkieliset tekstit, lukuun ottamatta standardin SFS-EN 82045-2 liitteitä, joista osa on julkaistu sisällöstä johtuen vain englannin kielellä. Sähköisessä versiossa on mukana myös standardien englanninkieliset tekstit, jolloin se soveltuu lisäksi kansainväliseen toimintaympäristöön.
Standardeja pidetään yllä ja niihin tehdään muutoksia ja lisäyksiä kansainvälisen standardisoinnin kehittyessä. Standardien uudet painokset ja tämän käsikirjan otsikkoon liittyvät mahdolliset uudet standardit julkaistaan yksittäisinä standardeina. Tiedot voimassa olevista standardeista saa voimassa olevasta SFS-luettelosta, joka löytyy myös Standardisoimisliiton Internet-sivuilta www.sfs.fi. Käsikirja uusitaan tarvittaessa, kun standardeihin on tullut riittävän paljon lisäyksiä ja muutoksia.
Tämä käsikirja on laadittu Seskon ja SFS:n yhteistyönä keväällä 2006.
SFS-käsikirjoilla on samanlainen tekijänoikeus kuin standardeilla. Osittainenkin julkaiseminen ja kopioiminen on sallittu vain SFS:n luvalla.
Sisällys
Esipuhe
SFS-EN 62023 Teknisen informaation ja dokumentaation jäsentely
Esipuhe
Johdanto
1 Soveltamisalue
2 Viittaukset
3 Määritelmät
3.1 Jäsentelyä koskevat yleistermit
3.2 Dokumentaatioon liittyviä yleisiä termejä
3.3 Erityistermit
4 Yleistä.
4.1 Järjestelmien, asennuksien ja tuotteiden jäsentelyn perusperiaatteet
4.2 Kohteet ja kohteita kuvaavat dokumentit
4.3 Dokumentaation rakenne ja dokumentin rakenne
4.3.1 Dokumentaation rakenne
4.3.2 Dokumentin rakenne
5 Päädokumentti ja täydentävät dokumentit
5.1 Yleistä
5.2 Päädokumentin sisältö
5.2.1 Dokumentin osat
5.2.2 Yksilöintiosa
5.2.3 Täydentävien dokumenttien osa
5.2.4 Määrittelyosa
5.3 Päädokumentin ja täydentävien dokumenttien väliset suhteet
5.3.1 Päädokumentti
5.3.2 Täydentävät dokumentit
5.4 Yhden tason ja usean tason päädokumentit
5.5 Soveltaminen
5.6 Päädokumentin luokittelu
Liite A (opastava) Esimerkki yksilöintiosan, täydentävän osan ja määrittelyosan sisältävästä päädokumentista
Liite ZA (velvoittava) Kansainväliset standardit, joihin viitataan tässä standardissa, ja niitä vastaavat eurooppalaiset julkaisut
Kirjallisuusluettelo
Kuva 1 Kohteiden yleinen jäsentely
Kuva 2 Esimerkki teknisen dokumentin loogisesta rakenteesta
Kuva 3 Yksittäisen kohteen dokumentaation rakenne
Kuva 4 Päädokumentit ja täydentävät dokumentit; kuvaus eri asteista informaation jakamisessa eri dokumentteihin
Kuva 5 Kohteista ja dokumenteista muodostuva dokumentaation rakenne
SFS-EN 61355 Teollisuuslaitosten, järjestelmien ja laitteiden dokumenttien luokittelu ja tunnistaminen
Esipuhe
Johdanto
1 Soveltamisala
2 Viittaukset
3 Määritelmät
4 Dokumenttilajien luokittelu
4.1 Yleistä
4.2 Dokumenttilajien luokituskoodi
4.2.1 Dokumenttilajien luokittelun pääperiaatteet
4.2.2 Dokumenttilajien luokituskoodin (DCC) rakenne
4.3 Dokumenttilajien valinta luokkiin
4.3.1 Luokitusmenetelmä
4.3.2 Vakiintuneiden dokumenttilajien luokittelu
4.3.3 Vakiintumattomien dokumenttilajien luokittelu
4.3.4 Yhdistelmädokumenttilajien luokittelu
5 Dokumenttientunnus
6 Dokumenttisarjat
7 Soveltamisohjeet
7.1 Välineet yhteydenpitoon dokumenttien vaihtamisessa
7.2 Dokumenttitunnuksen käyttäminen dokumenttien tunnistamiseen
Taulukot
A.1 Tekniikan alueita osoittavat kirjainkoodit
A.2 Dokumenttilajien luokituskoodi (DCC) ja dokumenttilajien luokkien kuvaukset
B.1 Sähkötekniikan alueella käytetyt dokumenttilajit
C.1 Esitystavan kirjainkoodi
Kuvat
1 Dokumenttilajien luokittelurakenne
2 Dokumenttilajien luokituskoodin rakenne
3 Dokumenttitunnuksen periaate
4 Esimerkki erään järjestelmän rakenteista ja dokumentaation järjestelmän mukaisesta rakenteesta
5 Dokumentin sivujen tunnistaminen
6 Esimerkki dokumenttia koskevan informaation esittämisestä otsikkokentässä
D.1 Dokumenttien vaihtoluettelo: yleinen osa
D.2 Dokumenttien vaihtoluettelo: kohteen mukainen osa
D.3 Dokumenttien vaihtoluettelo: esimerkki luettelon täyttämisestä
Liitteet
A Koodikirjaimien taulukot
B Vakiintuneet dokumenttilajit ja niiden lyhyt kuvaus
C Dokumenttilajeja koskeva lisäinformaatio yhteydenpitoa varten
D Dokumenttien vaihtoluettelot
E Kirjallisuus
ZA (velvoittava) Kansainväliset julkaisut, joihin tässä standardissa viitataan
ja niitä vastaavat eurooppalaiset julkaisut
ZX (kansallinen) Tässä standardissa viitattuja julkaisuja vastaavat kansalliset standardit
SFS-EN 82045-1 Dokumenttien hallinta. Osa 1: Periaatteet ja menetelmät
Esipuhe
Johdanto
1 Soveltamisala
2 Velvoittavat viittaukset
3 Määritelmät
3.1 Yleistä
3.2 Dokumenttiin liittyvät asiakohdat
3.3 Tuotteeseen liittyvät asiakohdat
3.4 Työn kulkuun liittyvät asiakohdat
4 Dokumenttien hallinnan periaatteet
4.1 Yleistä
4.2 Metadatan tukemat prosessit
4.3 Dokumentin käsitteet
4.4 Linkitetyt dokumentit
4.5 Dokumentin versiot
5 Dokumenttien metadata suhteessa niiden ympäristöön
5.1 Yleistä
5.2 Yhteen tai useampaan käsiteltävään kohteeseen liittyvä metadata
6 Dokumentin elinjakson aikaisiin toimintoihin liittyvä metadata
6.1 Yleistä
6.2 Aloitusvaihe
6.3 Valmisteluvaihe
6.4 Perustamisvaihe
6.5 Käyttövaihe
6.6 Muutosvaihe
6.7 Arkistointivaihe
6.8 Poistovaihe
7 Standardinmukaisuusvaatimukset
Liitteet
Liite A (opastava) Dokumenttien hallintajärjestelmän ympäristö
Liite B (opastava) Luettelo käytetyistä lyhenteistä
Kirjallisuutta
Liite ZA (velvoittava) Muut kansainväliset standardit, joihin viitataan tässä standardissa, ja niitä vastaavat eurooppalaiset julkaisu
Liite ZX (Kansallinen liite) Tässä standardissa viitattuja julkaisuja vastaavat kansalliset standardit
Kuvat
Kuva 1 Dokumentti ja siihen liittyvä metadata
Kuva 2 Yhdistelmädokumentin käsite
Kuva 3 Dokumenttiryhmän käsite
Kuva 4 Dokumenttijoukon käsite
Kuva 5 Peräkkäin pätevänä olevat dokumentin versiot verrattuna samanaikaisesti pätevänä oleviin
Kuva 6 Kypsyyden käsite
Kuva 7 Dokumentin elinjakson aikana suoritettavia toimenpiteitä
Kuva A.1 Dokumentin hallintajärjestelmän ympäristö
SFS-EN 82045-2 Dokumenttien hallinta. Osa 2: Metadataelementit ja informaation viitemalli
Esipuhe
Johdanto
1 Soveltamisala
2 Velvoittavat viittaukset
3 Termit, määritelmät ja lyhenteet
3.1 Termit, määritelmät
3.2 Lyhenteet
4 Metadatan koostetaulukon rakenne
4.1 Yleistä
4.2 No. ja DMA (Dokumenttien hallintatoimenpide)
4.3 Obl. (Tarve)
4.4 Metadatan tunniste
4.5 Metadatan nimike
4.6 Määritelmät
4.7 Ennalta määrätyt arvot
4.8 Viittaus EXPRESS informaatiomalliin
4.9 Viittaus XML dokumenttityypin määrittelyyn (DTD)
4.10 Ristikkäiset viittaukset muihin standardeihin tai suosituksiin
5 Säännöt metadatan esittämiseen dokumenteissa
6 Yhteydet IEC 82045-2 ja muiden informaatiomallien välillä
7 Vaatimukset yhdenmukaisuudelle
7.1 Yleistä
7.2 Yhdenmukaisuusluokka 1 (CC 1)
7.3 Yhdenmukaisuusluokka 2 (CC 2)
7.4 Yhdenmukaisuusluokka 3 (CC 3)
8 Dokumenttien hallinnan metadatan resurssi
Liitteet
Liite A (velvoittava) Dokumenttien hallinnan informaatiomalli
A.1 Yleistä
A.2 Viitemalli dokumenttien hallintaan
A.3 Olioiden luettelo
A.4 Entity descriptions
A.5 Referencing to objects of interest external to the information reference model of IEC 82045-2
A.6 Express source code
A.7 EXPRESS-G graphical representation
Liite B (velvoittava) XML toteutus dokumenttien hallintadatalle
B.1 Yleistä
B.2 Johdanto XML DTD:lle
B.3 XML Document Type Definition (DTD)
B.4 Soveltamisesimerkki 1: Metadata tälle standardidokumentille
B.5 Soveltamisesimerkki 2: Metadata piirikaaviolle
Liite C (opastava) Suhteet muihin tämän alueen metadataa käsitteleviin standardeihin
C.1 Suhde standardiin ISO 7200:2004
C.2 Suhteet standardiin ISO 15836 – Information and documentation – The Dublin Core metadata element set
C.3 Suhteet standardiin ISO 690-2
Liite D (velvoittava) Informaatiokohteen rekisteröinti
D.1 Dokumentin yksilöinti
D.2 Rakennekaavion yksilöinti
Liite E (opastava) Hypoteettinen käytäntöjen toteutuksen yhdenmuksenmukaisuuden vakuutus (PICS)
Liite ZA (velvoittava) Muut kansainväliset standardit, joihin viitataan tässä standardissa,ja niitä vastaavat eurooppalaiset julkaisut
Liite ZX (kansallinen liite) Tässä standardissa viitattuja julkaisuja vastaavat kansalliset standardit
Kuvat
Kuva 1 Yhteydet IEC 82045-2 ja muiden informaatiomallien välillä
Taulukko 1 CC 1-luokalle varatut oliot
Taulukko 2 CC 2 luokalle varatut lisäoliot
Taulukko 3 CC 3 luokalle varatut lisäoliot
Taulukko 4 Metadatan kokoelma
Kirjallisuus
