Tilbakereferanser og detaljspesifikasjoner

Etter å ha lest en del detaljspesifikasjoner begynner jeg å få en idè om enkelte ting jeg skulle ønske jeg hadde tilgjengelig i programvaren som brukes til å skrive slike j…. dokumenter i.

  • Tilbakereferanser
    Èn ting er referanser til andre deler av dokumentet – jeg vil gjerne også ha linker til samtlige deler som refererer til en gitt passasje i dokumentet. Eksempel: Hvis 1.1.3.4 og 2.3.1.5 referer til 3.2.4.1 vil jeg at det skal være mulig å stå i 3.2.4.1 og kunne gå direkte til 1.1.3.4 og 2.3.1.5
  • Breadcrumbs
    Yup – det er blitt en vanlig del av webhverdagen vår, og det hadde vært greit om dokumentasjonsverktøy hadde muligheten til å vise en sti bakover i tid. Ikke minst når man hopper som en hyperaktiv frosk mellom 1.1.3.4, 2.3.1.5 og 3.2.4.1
  • Markering av mulige invaliderte seksjoner ved oppdatering av en gitt seksjon.
    Egentlig det samme som tilbakereferanser, eller en avart av sådanne. Jeg vil ha en liste over hvilke seksjoner (definert som de som refererer til gjeldende seksjon) som muligens må oppdateres etter at jeg har endret gjeldende seksjon.
  • Seksjonssammendrag
    En kort beskrivelse av hva seksjonen gjelder, slik at det er mulig å bruke denne som en “merkelapp” når man la musen over lenken til den refererte seksjonen.

Jeg vet, det høres ut som en wiki – og det er ikke langt ifra. Det er et litt utvidet wikikonsept, men det hadde gjort jobben mye enklere for dem som skriver og ikke minst leser spesifikasjoner.

…og bare så det er sagt: Word egner seg dårlig…

Leave a Reply