Hvordan organisere dokumenter for gjenbruk i programvareutvikling?

Når man arbeider med dokumentasjon innen programvareutvikling, er det avgjørende å ha en klar og logisk struktur for å gjøre informasjonen lett tilgjengelig. En slik struktur kan hjelpe både utviklere og andre interesserte parter å raskt forstå innholdet i dokumentet, samt muligheten for gjenbruk av spesifikke deler av innholdet. Et av de mest effektive verktøyene for å oppnå dette er gjennom bruken av nummererte overskrifter og innholdsfortegnelser som tydelig viser hovedtemaene i dokumentet.

Dokumentets oppbygning kan raskt analyseres ved å studere dens disposisjon. Programvareverktøy kan automatisk trekke ut en disposisjon fra dokumentet og dele det opp i tematiske seksjoner, og dermed vise sammenhenger mellom disse seksjonene. Dette gjør det mulig å forstå dokumentets struktur i sin helhet. Selv om det ikke finnes strenge regler for hvordan overskrifter og disposisjoner skal bygges opp, finnes det visse mønstre som kan være til hjelp. Ofte vil overskrifter være substantivfraser, som for eksempel "Introduksjon til databasesystemer", "Fysisk datalagring" eller "Beskyttelse av databaser mot misbruk". I noen tilfeller kan overskrifter også være komplette setninger, som for eksempel "Hva gjør Interlisp unikt?".

En god overskrift skal kort og presist beskrive innholdet i seksjonen den leder til. Den fungerer som et innholdsindeks, og kan også brukes til å trekke ut nøkkelord som representerer innholdet i seksjonen. For eksempel kan både "Nettverksmodellen" og "Relasjonsmodellen" indekseres med nøkkelordet "Modell". I mange dokumenter vil undertitler arve attributter fra hovedoverskriften. For eksempel kan overskriften "Maskinvare" under "Stedskrav" bety "stedskrav for maskinvare". Dette forholdet kan vedvare på flere nivåer, og i noen vitenskapelige dokumenter kan overskriftene til og med gjentas.

I noen typer dokumenter, for eksempel kravspesifikasjoner, vil alle dokumentene følge den samme disposisjonen. Enkelte organisasjoner krever slik ensartethet i disposisjonen. Når man ser på dokumenter som dekker forskjellige faser av programvarelivssyklusen, vil man kunne se et slags overordnet mønster som binder sammen dokumentene på tvers av faser. For eksempel kan overskriften i et dokument som dekker designfasen relateres til en tilsvarende overskrift i et dokument som omhandler testing.

Ved å analysere disposisjonen til et dokument kan man identifisere hvilke deler som er viktigst for gjenbruk og hvordan informasjonen er relatert til andre deler av systemet. Hvis disposisjonen er godt strukturert og beskrivende, kan det gjøre det enklere å trekke ut informasjon som kan brukes på nytt i andre sammenhenger. Men ikke alle dokumenter har en tilstrekkelig godt organisert disposisjon, og i slike tilfeller vil det kreves ekstra arbeid for å abstraktere innholdet og representere det på en måte som gjør det lettere å manipulere og gjenbruke.

Når det gjelder gjenbruk av informasjon, kan en domenemodell være nyttig. En domenemodell reflekterer den overordnede organiseringen av informasjonen i et spesifikt domene. Den identifiserer objektene og operasjonene som er felles for domeneområdet, samt relasjonene og begrensningene mellom objektene og deres egenskaper. For utviklere som er på jakt etter gjenbrukbare komponenter, er det viktig at disse relasjonene og begrensningene er tydelig spesifisert.

En del av domenemodellen kan være en klassifikasjon, som grupperer like objekter sammen. En klassifikasjon kan være enumerert, der kunnskapen er delt opp i hierarkisk organiserte klasser. Dette kan for eksempel være nyttig i systemer som Dewey-desimal-systemet. En thesaurus, derimot, gir mer fleksibilitet og tillater flere attributter per term. Den gjør det mulig å indeksere dokumenter under flere termer og gir en bedre mulighet til å hente ut relevant informasjon gjennom naturlige språkrelasjoner.

En thesaurus kan enten være organisert hierarkisk, slik at relasjoner som "bredere enn" eller "smalere enn" er tydelig definert, eller den kan være alfabetisk. Uavhengig av form, gir en thesaurus en struktur som kan brukes til å organisere og finne dokumenter i både objekt- og dokumentorienterte systemer. Thesaurusen gjør det mulig for brukere å søke på flere termer samtidig, og dermed åpne for bredere eller mer spesifikke søkeresultater, noe som kan gjøre informasjonssøk mer effektivt.

Endtext

Hvordan effektivt hente informasjon fra et gjenbrukssystem

Et gjenbrukssystem for programvarekomponenter krever mer enn bare lagring av komponentene; det krever også en effektiv metode for å hente informasjon. En vanlig metode som brukes er å organisere informasjon ved hjelp av en abstraksjon eller modell, ofte kalt en domenemodell. Objektorienterte teknikker, som kan være arbeidskrevende i oppsettsfasen, resulterer i en struktur som er rik på informasjon og kan interrogeres på mange forskjellige måter. Dette gir store fordeler når man søker etter relevante dokumenter eller komponenter. Et tesaurus kan gi systemet grunnleggende kunnskap om domenet, slik at "intelligente" søk kan utføres, der man finner dokumenter ved å bruke termer som er relatert til ønskede termer, i stedet for å bare feile ved søk som ikke er direkte treff.

Når en utvikler ønsker å bruke et gjenbrukbart komponent, må han eller hun først finne ut hvilke komponenter som er tilgjengelige. Et system for komponentgjenbruk vil ikke være effektivt dersom det er vanskelig å hente ut den ønskede informasjonen. Brukere må gis fleksibilitet til å søke på forskjellige måter, for eksempel ved å søke etter spesifikasjoner eller delvis spesifikasjon av komponentene som trengs. Systemet bør være i stand til å vurdere hvor mye av spesifikasjonen som kan dekkes ved å kombinere eksisterende elementer fra biblioteket. Hvis biblioteket ikke inneholder den nødvendige informasjonen, skal brukeren kunne navigere gjennom de eksisterende komponentene for å finne relaterte elementer.

Programvareutvikling kan sees på som en prosess med stadig mer presise spesifikasjoner av et endelig produkt. I de tidlige stadiene av utviklingen kan spesifikasjonene være veldig vage, og utviklerne kan ha vanskelig for å uttrykke nøyaktig hva de trenger. Tross usikkerheten rundt spesifikasjonene, bør et godt gjenbrukssystem være i stand til å tilby nyttig informasjon, selv når søket er uklart. Dette kan kalles iterativ søking, der utvikleren gradvis forbedrer søket basert på de resultatene som allerede er hentet, og finner mer presise treff med hver iterasjon.

En viktig del av et gjenbrukssystem er muligheten for å bruke et tesaurus for å utvide søket. Hvis en utvikler søker etter komponenter relatert til et spesifikt begrep, som for eksempel "depth-first traversal", og systemet ikke finner en eksakt match, kan det finne det nærmeste relaterte begrepet i tesaurusen og bruke dette for videre søk. Hvis for eksempel "grafalgoritmer" er et bredere begrep som dekker "depth-first traversal", vil systemet returnere dokumenter relatert til "grafalgoritmer", som kan inneholde den nødvendige informasjonen. Dette gjør at søket kan være fleksibelt og ikke nødvendigvis avhengig av presise begreper.

En annen utfordring med gjenbrukssystemer er konsistensen i indeksene. Når et bibliotek inneholder tusenvis av komponenter som er indeksert av forskjellige personer, kan det oppstå inkonsistenser i hvilke termer som brukes for å representere de samme konseptene. For å håndtere dette problemet er det viktig å ha strenge kontrollmekanismer for indeksering, slik at de valgte begrepene er konsekvente og relevante. Dette kan for eksempel innebære at man skaper spesifikke retningslinjer for hvordan komponentene skal beskrives og indekseres, for å sikre at relaterte komponenter kan finnes ved hjelp av ulike termer.

Det er også viktig å merke seg at systemer som bruker fritekstsøk, krever at brukeren vet hvilket begrep de skal søke etter. Fritekstsøk kan feile i å finne dokumenter som er relevante, men bruker forskjellige termer. Et system som benytter seg av et konseptmodell, som beskrevet i forrige kapittel, kan gi mer presise søkeresultater ved å bruke attributtene og verdiene knyttet til hvert dokument. Disse attributtene gir mer detaljerte indikasjoner på hva dokumentet handler om, og hvordan det er relevant for et spesifikt tema.

For et effektivt søkesystem er det avgjørende at det ikke gir et forvirrende antall treff som brukeren må navigere gjennom. Når man beveger seg gjennom et tesaurus eller et hierarki av klasser, bør systemet presentere et håndterbart antall relevante alternativer, for å unngå å overvelde brukeren med informasjon. Dette krever en god balanse mellom presis søkefunksjonalitet og et system som er brukervennlig og oversiktlig.