DataMuseum.dk

top - metrics - download

    Length: 9216 (0x2400)
    Types: TextFile
    Names: »aldoks2«

└─⟦a41ae585a⟧ Bits:30001842 SW-save af projekt 1000, Alarm-system
    └─⟦72244f0ef⟧ 
        └─⟦this⟧ »aldoks2« 

TextFile

>ul
Forord

Dette er anden version af DOKS-manualen.

Systemet har nu været benyttet i praksis nogle måneder, hvilket har vist et par uhensigtsmæssigheder,
der hermed rettes.

Ændringerne er følgende:

>in4
>ti-2
- Et 
>ul
versionsnummer
kan tilføjes efter DOKS-nummeret.

>ti-2
- Løbenumre er ikke længere fortløbende og er derfor blevet døbt
om til "skriftnumre".
         
>ti-2
- Der er indført to nye hovedgrupper: RC og RF.
  
>ti-2
- Cifre er ikke længere tilladt i undergrupper (f.eks. er
ATPRM4 ikke længere en lovlig undergruppe).
>in-4

>np
>a1 INDLEDNING
>fo @üAL.DOKS.1/2ü@
Til identifikation af skriftligt materiale i projekter indføres et generelt dokumentationssystem, DOKS.

>a2 Omfang.
>ul
Alt
skriftligt materiale er omfattet af DOKS, d.v.s. f.eks. breve, notater, mødereferater, specifikationer, manualer,
uddannelsesmateriale o.s.v.

>a1 FORMATET FOR IDENTIFIKATIONEN.
En DOKS-identifikation af et skrift består af tre dele adskilt af punktummer:




nemlig hovedgruppe, undergruppe og skriftnummer. Refereres til en bestemt version af et skrift kan DOKS-nummeret
efterfølges af et versionsnummer.

Dette adskilles fra DOKS-nummeret med en "/":




Det understreges at et DOKS-nummer 
>ul
ikke må indeholde mellemslag
.

Systemet er opbygget i træstruktur:

>ne10
  Hovedgrupper

  Undergrupper

  Skrifter

>ne17
>a2 Hovedgrupper.
Der findes følgende hovedgrupper:

  AL  Almindelig information, mødereferater o.lign.
  RC  RC 79 internt (projektmødereferater o.s.v.)
  SP  Specifikationer
  SD  Softwaredokumentation
  HD  Hardwaredokumentation
  RF  Referencemateriale, artikler, bøger o.s.v.
  TR  Træning af personale
  IN  Installationsbeskrivelser
  OI  Operatørinstruktion, driftsvejledning

I det følgende beskrives indholdet af de enkelte hovedgrupper mere udførligt.

>a3 AL.
Under hovedgruppen "AL" registreres alt af generel karakter. Det gælder således:

>ne7
  - Notater
  - Mødereferater
  - Breve
  - Diverse overordnede beskrivelser
  - Materiale vedr. DOKS

>a3 RC.
Under "RC" registreres skrifter, der er beregnet til internt RC 79 brug.

>ne7
Det gælder f.eks.:

  - Projektledergruppens skrifter
  - Projektlog
  - Tidsplaner
    osv.

>a3 SP.
Under "SP" registreres alle former for specifikationer, hardware såvel som software.
  
>ex Specifikation i ALARM-systemet.

>ne8
Det gælder f.eks. ved specifikation af:

  - Alarmterminalen
  - Software i terminalstationen
  - Software i distriktscentret
  - Hardware til DOV
    osv.

>a3 SD.
"SD" er hovedgruppe for softwaredokumentation. D.v.s. f.eks.:

>ne7
  - Referencemanualer
  - User's Guides til moduler, der ikke betjenes af
    driftspersonalet
  - Programmer's Guides
  - Vedligeholdelsesmanualer

>a3 HD.
"HD" er hovedgruppe for hardwaredokumentation. D.v.s. f.eks.:

>ne4
  - Tekniske manualer
  - Spare parts lister
  - Hardware test programmel

>a3 RF.
Under "RF" registreres eksternt materiale af interesse for projektet.

Det vil typisk dreje sig om bøger, artikler fra tidsskrifter o.s.v.

>a3 TR.
Under "TR" registreres alt vedrørende uddannelse i brug af systemet. Det gælder
>ne7
således f.eks. materiale til brug ved uddannelse af:

  - Montører
  - Teknikere
  - Driftspersonale
  - O.s.v.

>ne 7
>a3 IN.
"IN"-hovedgruppen indeholder al dokumentation vedrørende installation af systemet, d.v.s. både hardwareinstallationsbeskrivelser
og softwareinstallationsbeskrivelser.

IN henvender sig f.eks. til de montører, der fysisk skal installere systemet.

>a3 OI.
Under "OI" registreres dokumentation omkring driften af systemet. Det gælder således først og fremmest
driftshåndbogen.

>a2 Undergrupper.
Hver hovedgruppe har et sæt af undergrupper. Disse er ikke nødvendigvis sammenfaldende, idet en 
undergruppe ikke behøver eksistere under samtlige hovedgrupper.

For dele af systemet vil det være relevant at sprede dokumentation på flere hovedgrupper. Det
gælder f.eks. et fysisk apparats forskellige dele. Der findes både specifikationer (SP), hardwaredokumentation (HD),
uddannelsesmateriale (TR), installationsbeskrivelser (IN) og driftsvejledning (f.eks. test) (OI).

I disse tilfælde benyttes 
>ul
samme undergruppe 
under de forskellige hovedgrupper.

>ex ALARM-systemet.

Alarmterminalens power supply modul registreres i undergruppen ATPSM. Denne undergruppe findes under
hovedgrupperne SP, HD, TR, IN og OI.

Undergrupperne laves efterhånden som der bliver behov for dem. Alle undergrupper skal autoriseres centralt (netop
for at sikre at der ikke findes forskellige undergrupper, der behandler samme emne).

I det følgende beskrives de undergrupper, der i øjeblikket findes under hovedgrupperne AL og SP.

>a3 Undergrupper under AL.
Følgende undergrupper findes i øjeblikket:

>in11
>ti-7
AL.RC@@@Generelle skrifter fra RC, evt. med flere 
forfattere.

>ti-7
AL.JT@@@Generelle skrifter fra JTAS, evt. med flere 
forfattere.

>ti-7
AL.STL@@Generelle skrifter fra Søren T. Lyngsø, evt.
med flere forfattere.

>ti-7
AL.DOKS@Al information omkring DOKS-systemet, f.eks.
dette skrift, oplysning om nye undergrupper
o.s.v.

>in-11
Herudover findes der en gruppe for hver person:

  STB, WIB, PF, BJ, HM, OER, HSA, JG, HG, AWG, GKF.

Under de personlige undergrupper registreres f.eks. breve og notater af generel karakter med kun een forfatter.

>a3 Undergrupper under SP.
I øjeblikket findes følgende undergrupper under hovedgruppen "SP":

 SP.AT     Generelt om alarmterminal, (f.eks. protokol).

 SP.ATPRM  AT Processor Modul.

 SP.ATPAM  AT Parallel Modul.

 SP.ATPSM  AT Power Supply Modul.

 SP.ATKAB  AT Kabinet.

 SP.TSSYS  Terminalstationen

>ne8
>a3 Andre undergrupper.
De øvrige hovedgruppers undergrupper er ikke fastlagt på nuværende tidspunkt.

>a2 Skriftnumre.
Identifikationens sidste felt benyttes til et skriftnummer inden for den pågældende
<hovedgruppe>.<undergruppe>.

>ul
Skriftnumre er ikke nødvendigvis fortløbende
.

Står man f.eks. med et skrift med DOKS-nummeret SP.AT.10 kan det ikke nytte noget at spørge
hvor SP.AT.9 er henne - det findes måske slet ikke.

Skriftnumre under en undergruppe kan indeholde en implicit underdeling af de skrifter, der findes
under den pågældende undergruppe.

>ex Skriftnumre.

I alarmsystemet findes således 4 grupper af skrifter under undergruppen ATPAM, nemlig:

  - AT Parallelmodul, Serieinterface
  - AT Parallelmodul, Protokolfunktioner
  - AT Parallelmodul, Parallelinterface
  - AT Parallelmodul, Strømforsyning, Sikkerhedskrav,
                      Miljøkrav og Mekaniske Mål.

Skriftnumre tildeles da disse under-undergrupper i klumper på f.eks. 10, således at skrifter
om AT Parallel Modulets serieinterface får numre fra 10 til og med 19, skrifter om AT Parallel Modulets
protokolfunktioner får skriftnumre fra 20 til og med 29 o.s.v.

>a2 Versionsnumre.
Når et skrift udkommer i en 
>ul
ny version
ændres dets DOKS-nummer ikke; der tilføjes derimod et versionsnummer efter DOKS-nummeret og adskilt
fra dette med en "/".

>ne7
>ex Versionsnummer.

Et bestemt skrift kan f.eks. have DOKS-nummeret:

SP.ATPAM.51

tredje version af dette skrift hedder:

SP.ATPAM.51/3

Versionsnumre er fortløbende og startende fra 1.

>a1 ANSVARSFORDELING
Alle DOKS-numre registreres centralt (i alarmsystemet af STB).

Der vil blive ført lister over hver enkelt skriftgrupperække. Dette sker på specielle formularer,
se f.eks. appendix A.

En gang om måneden udsendes en indholdsfortegnelse over de indtil nu benyttede numre.

Ansvaret for visse undergrupper kan uddelegeres til bestemte personer, der dog ikke hermed fritages
for at registrere nummeret centralt.

Ansvaret for de personlige undergrupper under AL (f.eks. AL.HM) 
påhviler 
>ul
den enkelte person
. Til brug ved registrering 
>ul
skal
anvendes de fortrykte formularer (DOKS-formular 2).

>a1 FYSISKE FORMATER
>ul
Alle
skrifter forsynes på forsiden med:

   DOKS-nummer (evt. /version)
   Dato (på formatet: DD.MM.19YY)
   Forfatterinitialer

Bemærk venligst formatet for datoen, f.eks.
  1. februar 1980 skrives: 01.02.80

>ul
Alle
skrifter forsynes
>ul
inden
udsendelse med 4 huller til standard A4-ringbind.

Så vidt muligt anvendes standardforside (DOKS-formular 1).

Det er dog tilladt - såfremt specielle hensyn taler herfor - at anvende andre forsider.

Mødereferater, breve o.lign. skrives på særligt papir og behøver ingen forside. De er dog
>ul
ikke
fritaget for reglen om
>ul
DOKS-nummer, dato, forfatter samt 4 huller
.

▶EOF◀