Håndbok i regelverksskriving-skal slettes

__NUMBEREDHEADINGS__

Hensikt og omfang

Håndbok for skriving av teknisk regelverk er et styrende dokument for dem som skriver Jernbaneverkets tekniske regelverk. Hensikt med en felles håndbok er å sikre et at regelverket tilfredstiller de formelle krav som stilles til kravsamlinger i tillegg til å samordne de ulike bøkene og kapitlene og bidra til at disse både er konsistente i ord og struktur.

Håndboka skal definere strukturen til et krav, bruk av språket og relasjonen mellom Jernbaneverkets tekniske regelverk og andre normative dokumenter som gjelder for det nasjonale jernbanenettet.

Håndboka skal omhandle kun selve regelverket som en kravsamling og ikke de spesifikke tekniske detaljene (publikasjonsform, utseende o.l.). Det sistnevnte finnes det et eget maldokument for. Håndboka skal omhandle følgende sider av regelverket:

1. Kravformulering
2. Kravsporing
3. Praktisk oppbygning av teknisk regelverk

Håndboka skal også være en samling krav og anbefalinger til skriving av regelverket. Kravformulering i håndboka skal følge samme mønster som krav i regelverket:

1. Krav i håndboka skal formuleres ved bruk av modalt hjelpeverb «skal»
2. Anbefalinger i håndboka skal formuleres ved bruk av modalt hjelpeverb «bør»
3. Valgfrie alternativer skal formuleres ved bruk av modalt hjelpeverb «kan»

Håndboka omhandler ikke metoder for etablering (elisitering), faglig analyse og validering av krav. Dette må eventuelt komme i en senere utgave. Mal:Jernbaneinfrastrukturforskriften stiller krav om at infrastrukturforvalter skal benytte prosesstandarden EN 50126 (1999) ved bygging av ny jernbaneinfrastruktur. For endring av krav og behandling av dispensasjonssøknader finnes det egne instrukser i styringsdokumentene for teknisk regelverk som stiller krav til faglig analyse og høring/kontroll.

Teknisk regelverk Felles bestemmelser/Generelle bestemmelser angir også bestemmelser for regelverket og gjelder ved konfilkt over denne håndboka.

Hva skal Teknisk regelverk være?

Hjemmel for Teknisk regelverk

I dette avsnittet oppgis hjemmelen til Teknisk regelverk.

Det finnes både nasjonale krav til jernbaneinfrastruktur hjemlet i Mal:Jernbaneinfrastrukturforskriften og internasjonale krav til jernbaneinfrastruktur hjemlet i tekniske spesifikasjoner for samtrafikkevne (TSIer) hjemlet i norsk rett via Mal:Samtrafikkforskriften. Noen krav kan adopteres og følges direkte mens andre krav igjen krever et mer detaljert kravsett for å kunne fungere som underlag for prosjektering og bygging.

Videre krever Mal:Jernbaneinfrastrukturforskriften at «jernbaneinfrastrukturen skal utformes slik at virksomheten drives innenfor akseptabel risiko. Delsystemet infrastruktur, de faste innretninger av delsystemet energi og de faste innretninger av delsystemet styring, kontroll og signal samt de enkelte komponenter i hvert delsystem skal være teknisk og funksjonelt harmonisert.» Det vil si at det må etableres en formel kravsamling som beskriver hvordan harmoniseringen skal utføres i praksis.

Mal:Jernbaneinfrastrukturforskriften krever også at «jernbaneinfrastrukturen skal prosjekteres, bygges og testes i henhold til nasjonale og internasjonale standarder. Infrastrukturforvalter skal gjøre en sikkerhetsmessig vurdering av avvik fra valgte standarder. Vurderingen skal dokumenteres.» Det betyr at infrastrukturforvalter bør foreta en vurdering hvorvidt en internasjonal standard skal følges eller ikke. Denne vurderingen må publiseres i virksomheten slik at den kan etterleves.

Mal:Jernbaneinfrastrukturforskriften krever at «infrastrukturforvalter skal drifte og vedlikeholde jernbaneinfrastrukturen i henhold til nasjonale og internasjonale standarder. Infrastrukturforvalter skal ha en vedlikeholdsplan for hver strekning. Vedlikeholdsplanen skal inneholde grenseverdier for alle systemer, deler og komponenter av sikkerhetsmessig betydning som angir når umiddelbare tiltak skal iverksettes.» Grenseverdiene som utløser vedlikehols må etableres og publiseres i virksomheten.

For å tilfredstille myndighetskravene gitt over har Jernbaneverket valgt følgende som del av sitt styringssystem:

a) Hjemmel: Teknisk regelverk skal ihht Felles bestemmelser/Forord sikre harmoniserte tekniske løsninger ved prosjektering og bygging og et forsvarlig vedlikehold av det statlige nasjonale jernbanenettet.

Som en konsekvens av dette er teknisk regelverk er en samling normaler innenfor de ulike jernbanetekniske fagområder.

Grensenitt for Teknisk regelverk

Teknisk regelverk har grensesnitt mot en rekke andre dokumenter som illustrert i <xr id="fig:Grensesnitt" />. Myndighetskrav og strategier er førende for regelverket. Teknologi utgir lærebøker i jernbaneteknikk, prosesskoder og tekniske spesifikasjoner som følger (av) regelverket. Andre dokumenter i Jernbaneverket følger eller bygger på Teknisk regelverk, for eksempel generiske arbeidsrutiner og kravspesifikasjoner generelt.

<figure id="fig:Grensesnitt">

Fil:Teknisk regelverks grensesnitt.png

Teknisk regelverks grensesnitt

</figure>

VIDERE ER UNDER ARBEID

Følgende dokumenter

Andre

Teknologien for jernbane er i stadig endring (samfunnets og markedets behov, jernbanens behov, tilgjengelig teknologi og tekniske løsninger, overordnede krav osv). Teknisk regelverk skal favne disse endringene slik at infrastrukturen bygges etter de gjeldende ønsker og krav, samt etter de erfaringer en får underveis med drift av nye og gamle anlegg. Derfor må regelverket kontinuerlig vedlikeholdes. Teknisk regelverk bør til enhver tid være oppdatert utfra følgende prinsipper:

a) Stille funksjonskrav der dette er heniktsmessig fremfor spesifisering av teknisk løsning.

b) Omtale eksisterende og ny teknologi.

c) Henvise til myndighetskrav, lover og forskrifter og strategier.

Grensesnitt mot myndighetskrav

Myndighetskrav er lover, forskrifter og TSI-er som setter helt spesifikke krav til utforming eller funksjoner i infrastrukturen. Ved at myndighetskrav formuleres som en del av regelverkskravene øker lesbarheten av regelverket, dette i motsetning til om det kun står en henvisning til kravet. En må bestrebe seg på å formulere regelverket slik at det blir en mest mulig komplett kravsamling.

a) Regelverket bør henvise til, og ha kravformuleringer basert på lover, forskrifter og TSI-er.

Grensesnitt mot strategier

Strategiene setter mål og angir fremgangsmåter som skal brukes for å nå målene. Strategiene kan være overordnede og gitt av myndighetene (TSI-er), eller interne strategier. Teknisk regelverk skal innehold krav som er nødvendige for å gjennomføre strategiene. Der strategiene gir overordnede mål kan disse beskrives som overordnede funksjonskrav i Teknisk regelverk. Disse formuleringene kommer naturlig tildlig i et kapittel eller avsnitt i regelverket.

a) Teknisk regelverk bør henvise til overordnede strategier.

Grensesnitt mot Lærebøker

Jernbaneverkets lærebøker omfatter en samling og oppdatering av tidligere utarbeidet læremateriell for ulike kurs og seminarer innen jernbanetekniske emner. Blant disse nevnes nordisk baneingeniørutdanning (NBIU), nordisk elektroingeniørutdanning (NEIU), jernbaneteknikk ved NTNU, jernbaneteknikk ved HIOA, baneteknikk på Jernbaneskolen osv. Læremateriellet til disse kursene er utarbeidet av ulike forelesere, NTNU-ansatte o.a. og er utgitt i forskjellige utgaver og på ulik form.

Målet med Jernbaneverkets lærebøker har vært å utarbeide et sett med enhetlige og oppdaterte lærebøker som er tilgjengelig for alle som arbeider med jernbanetekniske fag. Dette kan være egne ansatte, konsulenter, studenter, leverandører og myndigheter.

Jernbaneverekts lærebøker tar mål av seg til å inngående forklare virkemåten til systemer og komponenter som er jernbanespesifikke.

I Teknisk regelverk skal det forutsettes at leseren har inngående kjennskap til de aktuelle fagområdene.

a) Krav i Teknisk regelverk skal enkelt, presist og kortfattet beskrive krav til tekniske systemer og komponenter, henholdsvis for prosjektering, bygging og vedlikehold.

b) Lærebokstekst (grå bakgrunn) kan benyttes når kravet ikke er lett å forstå uten supplerende tekst.

c) Forklaringer i form av læreboktekst kan også benyttes når det er nødvendig å presisere valgmulighet.

d) Lærebøkene bør oppdateres når Teknisk regelverk endres.

Grensesnitt mot Tekniske spesifikasjoner for systemer og komponenter

Tekniske spesifikasjoner er underlag for anskaffelser av systemer og komponenter. De tekniske spesifikasjonene oppgir konkrete krav til virkemåte, ytelse, utforming, mål og vekt, dimensjoner, farge, miljø, materialvalg etc. for systemer og komponenter som er definert som driftskritiske. Spesifikasjonene skal være generelle og leverandøruavhengige. Spesifikasjonene skal inneholde hensikt og omfang.

Teknisk regelverk beskriver ikke disse komponentene i detalj, men snarere systemet som disse skal virke i. Dermed vil regelverket kunne beskrive plassering, funksjonskrav, ytelse etc. for komponentene, men heller ikke noe mer.

a) Tekniske spesifikasjoner skal angi presise krav slikt at det kan evalueres om kravet er oppfylt

b) Tekniske spesifikasjoner skal i sin formuleringer gjøre det mulig for teknologiske innovasjoner

c) Spesifikasjonene skal fortrinnsvis skrives for komponenter som en vet eksisterer og som finnes i markedet

Kravformulering

Innledning

Å formulere et krav riktig er viktig for å sikre at leseren oppfatter hva kravet virkelig er og dermed kan være i stand til å oppfylle det. Dette avsnittet gir en oversikt over hvilke regler som gjelder for formulering av krav i teknisk regelverk. Mer detaljert informasjon om kravspesifikasjon finnes i og .

Overordnet

En definisjon av et krav kan være: Mal:Lærebokstoff

Hensikten med å fremme et krav er å sikre at jernbaneinfrastrukturen blir prosjektert, bygd, vedlikeholdt og kontrollert slik som vi ønsker. Derfor gjelder følgende overordnet:

a) Tydelighet: Det skal tydelig fremkomme at et krav er et krav.

b) Kompletthet og utvetydighet: Et krav skal være komplett og utvetydig formulert.

c) Nødvendighet og tilstrekkelighet: Et krav eller en samling av krav skal være nødvendig og tilstrekkelig.

Det betyr at vi må ha regler for hvordan krav skal formuleres og sikre at de formuleres eksplisitt og ikke implisitt i annen tekst. Vi må også tenke igjennom både de faglige sidene av kravet, det vil si at kravet beskriver eksakt det vi ønsker å formidle, og hvordan vi formulerer kravene slik at misforståelser unngås. Samtidig er det viktig å være kritisk til kravene som føres inn i regelverket for å unngå overspesifisering eller unødvendige begrensninger.

Differensiering av krav

For å skille et krav fra annen tekst, for eksempel informasjon, forklaring eller veiledning, er betydningen av ordene som danner en setning det viktigste virkemidlet. Dette kalles semantikk eller betydningslære og er således uavhengig av hvilken kommmunikasjonsløsning som kravet formidles over. Et krav kjennetegnes primært på bruken av modale hjelpeverb («skal», «bør» og «kan») og hvordan ordene i kravsetningen er satt sammen. Sekundært identifiseres også krav ved en form for nummerering som forklares nærmere i avsnitt om #Kravsporing.

For teknisk regelverk gjelder i henhold til Felles bestemmelser/Generelle bestemmelser#Dispensasjon fra teknisk regelverk følgende regel for bruk av modale hjelpeverb i kravsammenheng.

a) Skal: Krav skal formuleres med «skal».

b) Bør: Anbefalinger skal formuleres med «bør».

c) Kan: Valgfrihet skal formuleres med «kan».

For å sikre at det kun er krav som oppfattes som krav er det også en god praksis å unngå å bruke disse modale hjelpeverbene i annen tekst.

Teknisk regelverk er en samling av krav, flesteparten av dem er interne krav i Jernbaneverket, men for å presentere et mest mulig komplett regelverk for prosjektering, bygging og vedlikehold arves også krav fra myndighetene, for eksempel fra lover og forskrifter. Disse kravene gjelder uansett om og hvordan de står i regelverket eller ikke. Det er også viktig å skille på hvilke krav Jernbaneverket er ansvarlig for og hvilke Jernbaneverket er pålagt å følge fra myndighetene.

d) Skille interne og eksterne krav: Teknisk regelverk skal skille på krav som stilles internt i Jernbaneverket og krav som er arvet fra overordnede myndigheter.

1. Utførelse: Myndighetskrav kan gjentas ordrett. Da skal hjelpeverbet settes i kursiv og kravteksten skal inneholde sporing til myndighetskravet.
2. Utførelse: Myndighetskrav kan refereres eller henvises til uten bruk av modale hjelpeverb.

Avsnitt #Kravsporing sier mer om sporing av krav. Alternativ 2 om referering eller henvisning til myndighetskrav kan være nyttig dersom det er vanskelig eller for omfattende å gjenta eller oversette myndighetskravet på en god måte. Siden myndighetskrav gjelder uavhengig av teknisk regelverk er det god praksis at brukeren av regelverket forholder seg til kilden av et slikt krav og ikke en tolkning.

e) Utfyllende krav: Teknisk regelverk kan gi utfyllende krav til og informasjon om overordnede myndighetskrav.

1. Utførelse: Slike utfyllende krav skal håndteres som interne krav i Jernbaneverket.

Språk og lesbarhet

For å sikre forståelse av kravet er det viktig at vi formulerer oss på en konsistent måte. Da forenkles også bruken av datamaskinbaserte søkefunksjoner. Det er uheldig å 'variere språket' ved å bruke synonymer slik som i prosa. Bruk de enkleste ordene som får frem hensikten med det du vil si. Derfor gjelder følgende krav:

a) Presis formulering: Krav skal formuleres med uttrykk som har presis betydning.

1. Utførelse: Alle begreper, forkortelser, symboler og referanser som forekommer i et krav skal være definert.
2. Utførelse: Begreper og forkortelser bør være definert i Felles bestemmelser/Definisjoner, forkortelser og symboler.
3. Utførelse: Normgivende referanser som forekommer skal være definert i Felles bestemmelser/Generelle bestemmelser#Normgivende referanser eller respektive regelverksbok kapittel 4.

b) Ordliste: Teknisk regelverk skal skrives basert på #Ordliste.

I en stor kravsamling kan det være vanskelig å skille de mange kravene fra hverandre. Sammensatte og komplekse krav kan også være vanskelige å forstå og skille fra hverandre. Derfor gjelder følgende anbefalinger:

d) Tittel: Alle krav bør ha en tittel som gjør det enklere å forstå og referere til kravet.

1. Utførelse: Tittelen bør være unik innefor et avsnitt

e) Oppdeling: Uttrykk bør fordeles over flere krav dersom det øker lesbarheten.

<Maria: Noe om bruk av en, man og vi, om aktiv versus passiv?>

Kvantifisering og verifisering

Av både tekniske og økonomiske grunner er det viktig å kunne vurdere om et krav er oppfylt eller ikke. Derfor gjelder følgende krav:

a) Kvantitet: Det det er mulig skal krav være formulert kvantitativt.

b) Toleranser: Dersom annen toleranse ikke er angitt skal nøyaktigheten til et krav bestemmes av antall gjeldende siffer.

c) Verifikasjon: Krav skal indikere type verifikasjon.

Et kravs egenskaper og oppbygning

Det er en god regel å begrense et krav til sin enkleste form. Desverre er det imidlertid ofte ikke mulig uten at det går ut over den generelle lesbarheten, gjerne ved at det resulterer i mange tilsynelatende uselvstendige krav. Derfor gjelder følgende

a) Egenskaper: Et krav skal ha egenskaper som angitt i <xr id="tab:kravegenskaper" />.

b) Oppbygning: Et krav skal bygges opp som angitt i <xr id="tab:kravoppbygning" />.

1. Unntak: Krav kan samles i tabeller for bedre lesbarhet forutsatt at hvert krav tabellen representerer eksplisitt kan identifiseres.

<figtable id="tab:kravegenskaper">

Et kravs egenskaper

	Egenskap	Status	Forklaring	Hvordan implementere	Eksempel
c)	Identifikator	Krav	Se #Kravsporing	Foran kravteksten	a)
d)	Tittel	Anbefaling	Se #Språk og lesbarhet c)	Foran kravteksten	Minste radius
e)	Subjekt	Krav	Det produkt eller tjeneste som kravet omhandler	Som en del av kravteksten	plattformer
f)	Modalt hjelpeverb	Krav	«Skal», «bør» eller «kan»	Som en del av kravteksten	skal
g)	Nekting	Valgfritt	«Ikke»	Som en del av kravteksten	ikke
h)	Hovedverb	Krav		Som en del av kravteksten	legges (i)
i)	Objekt	Krav		Som en del av kravteksten	kurve med radius under 2000 meter
j)	Betingelse	Valgfritt	Begrensning eller presisering av kravets gyldighet	Som en del av kravteksten, se forøvrig r) unntak	nye
k)	Sporing	Krav	Begrunnelse eller kilde for kravet	Se #Kravsporing, for gjentakelse av myndighetskrav også som en del av kravteksten	(ihht.) Jernbaneinfrastrukturforskriften §3-4
l)	Verifikasjonsmåte	Krav	Se #Kvantifisering og verifisering	Implisitt i forståelsen av kravet eller eksplisitt som et underkrav
m)	Utføreelse	Valgfritt	Krav til utførelse, dvs. hvordan kravet skal tilfredsstilles	Som underkrav
n)	Utbedring	Valgfritt	Krav til utbedring, dvs. hvordan en mangel skal utbedres (gjelder vedlikeholdskrav), se Felles bestemmelser/Generelle bestemmelser#Tid til utbedring av feil	Som underkrav
o)	Operativ tiltak	Valgfritt	Spesifikasjon av operative tiltak inntil forholdet er utbedret (gjelder vedlikeholdskrav)	Som underkrav
p)	Dokumentasjon	Valgfritt	Krav til dokumentasjon, dvs. hvordan verifikasjonen av overholdelse av kravet skal dokumenteres	Som underkrav
q)	Assessering	Valgfritt	Krav til assessering, dvs. hvordan en assessor skal vurdere verifikasjonen av et krav	Som underkrav
r)	Unntak	Valgfritt	Spesifikasjon av tilfeller der kravet ikke gjelder	Som underkrav dersom dette ikke kan skrives j) betingelse
s)	Kompetanse	Valgfritt	Krav til kompetanse for å kunne arbeide med dette kravet	Som underkrav

</figtable>

<figtable id="tab:kravoppbygning">

Et kravs oppbygning

Identifikator) Tittel: Kravtekst Egenskap: Underkrav

</figtable>

Kravsporing

Forå kunne referere til et krav entydig gjelder følgende krav:

a) Alle krav skal ha en unik identifikator. Identifikatoren skal være unik for hele teknisk regelverk.

Formen på identifikatoren er ennå ikke fastsatt, men vil avklares etter en pilot.

Ved utarbeidelse av krav vil en basere seg på kilder. Eksempler på slike kilder er :

• Overliggende krav, herunder myndighetskrav
• RAMS-analyser

Ved endring av krav og behandling av dispensasjonssøknader er det viktig å kjenne til disse kildene. Derfor gjelder:

b) Alle krav skal spores til sin kilde og være i samsvar med denne.

c)Dersom et krav er relatert til en eller flere funksjoner bør disse identifiseres som en av kildene.

d) Regelverket skal inneholde en sporingsmatrise.

Praktisk oppbygning

I dette avsnittet gis det praktiske krav for oppbygningen av teknisk regelverk.

Regelverksbøker

a) Inndeling: Regelverksbøkene innenfor et fagområde bør deles inn i prosjektering, bygging og vedlikehold.

b) Felleskapitler: Alle regelverksbøker skal ha felles kapittel 1, 2 og 3 i bok Felles bestemmelser.

c) Kapittel 4: Alle bøker skal ha et kapittel 4 "Generelle tekniske krav".

Regelverkskapitler

a) Hensikt og omfang: Alle regelverkskapitler skal begynne med et avsnitt "Hensikt og omfang".

Vedlegg

a) Utfyllende vedlegg: Vedlegg til regelverket bør brukes for å gi utfyllende relevante krav eller informasjon.

b) Normativ/informativ: Det skal tydelig fremgå om et vedlegg til regelverket er normativt eller informativt.

1. Utførelse: Dette skal angis ved bruk av riktig modalt hjelpeverb ved henvisning til vedlegget.
2. Utførelse: Dette bør eksplisitt angis ved bruk av "(normativ)" eller "(informativ)" i vedlegget i vedleggsteksten.

b) Vedleggstype: Det bør tydelig fremgå hvaslags dokument et vedlegg er.

1. Utførelse: Dokumenttypene bør følge anbefalingene i styringssystemet, se .
2. Utførelse: Dokumentype bør angis i tittelen til vedlegget etter navnekonvensjonene i styringssystemet, se .

Krav

Felles bestemmelser/Generelle bestemmelser#Generelt for vedlikeholdskrav stiller krav til merking av vedlikeholdskrav som har forankring i sikkerhet eller i forskrift.

a) Rekkefølge: Krav i et avsnitt bør sorteres slik at viktige og overordnede krav kommer kommer før underordnede og detaljerte krav.

For oppbygning av et krav, se #Et kravs egenskaper og oppbygning.

Figurer og tabeller

Figurer og tabeller kan lette oversikten og lesbarheten av regelverket, men kan også føre til at de formelle kravene til krav gjengitt i denne håndboken ikke tilfredsstilles. Derfor gjelder følgende:

a) Figurer og tabeller: Krav skal ikke uttrykkes kun i figurer og tabeller.

1. Unntak: Figurer og tabeller kan likevel benyttes dersom hvert krav figuren eller tabellen representerer eksplisitt kan identifiseres.

Vedlegg

Ordliste

Vedtatt standard	Synonymer eller andre skrivemåter eller ord som ikke skal brukes i samme betydning og forbindelse	Kommentarer og anmerkninger
bru	bro
innskrenkning	innskrenking
km/h	km/t
kobling	kopling
lokomotivfører	lokfører, fører, togfører	lokomotivfører er et komplett og forståelig uttrykk, lokfører er en forkortelse, fører er rett ihht. førerforskriften men vanskelig å forstå i annen sammeheng siden uttrykket blir for generelt, togfører er en vanlig misforståelse (se for eksempel [1])
nasjonale jernbanettet	offentlige jernbanettet, statlige jernbanenettet	Mal:Jernbaneinfrastrukturforskriftenc: «jernbaneinfrastruktur som er beregnet på persontransport og/eller godstransport og som forvaltes av Jernbaneverket som infrastrukturforvalter»
plattform	perrong
skinnetopp	skinneoverkant, sok
snø	sne
sporveksel	sporveksler, pens
stigtrinn	stigetrinn	stigetrinn har en helt annen betydning.
strømavtager	pantograf
Teknisk regelverk	teknisk regelverk	Teknisk regelverk er egennavn og skal ha stor forbokstav
tunnel	tunell