DataMuseum.dk

top - metrics - download

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

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

TextFileVerbose

>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»