Kruisreferentie

Technische rapporten en instructies vereisen vaak cross-referenties—die verwijzingen naar andere plaatsen in hetzelfde document of naar andere informatiesystemen waar gerelateerde informatie te vinden is.

Een kruisverwijzing kan lezers op verschillende manieren helpen:

• Het kan hen wijzen op meer basisinformatie als ze bijvoorbeeld in een document zijn gedoken dat boven hun hoofd gaat.
• Het kan hen doorverwijzen naar meer geavanceerde informatie als ze bijvoorbeeld al weten wat je probeert te vertellen.
• Ook kan het hen naar gerelateerde informatie wijzen.

Gerelateerde informatie is het moeilijkste gebied om uit te leggen omdat uiteindelijk alles met elkaar verbonden is—er zou geen einde komen aan de kruisverwijzingen. Maar hier is een voorbeeld uit DOS—die troll die zich binnen pc-achtige computers schuilhoudt en je supposedly helpt. Er zijn verschillende manieren om bestanden te kopiëren: de COPY-opdracht, de DISKCOPY-opdracht en de XCOPY-opdracht. Elke methode biedt verschillende voordelen. Als je over de COPY-opdracht zou schrijven, zou je kruisverwijzingen naar deze andere twee willen zodat lezers een beetje kunnen rondkijken.

Natuurlijk gaat de voorgaande discussie uit van kruisverwijzingen binnen hetzelfde document. Als er te veel achtergrondinformatie is om in jouw document te behandelen, kun je naar een externe website, boek of artikel verwijzen dat die achtergrond biedt. Op die manier ben je niet verantwoordelijk voor het uitleggen van alles!

Componenten van kruisverwijzingen

Cross-referenties kunnen zijn intern (binnen hetzelfde document) of externaal (buiten het huidige document). De meeste richtlijnen voor cross-refereren hangen af van of de cross-referentie intern of extern is. Met externe bronnen kun je de titels van boeken, hoofdstukken, koppen en paginanummers niet controleren. Ze zullen waarschijnlijk veranderen!

Met kruisverwijzingen naar externe documenten:

• Cite geen titels van boeken, hoofdstukken, of koppen letterlijk woord voor woord. Verwijs in plaats daarvan naar het algemene onderwerp dat wordt behandeld.
• Cite geen exacte hoofdstuk- of sectienummers of exacte paginanummers.

Een goede kruisverwijzing bestaat uit verschillende elementen:

• Naam van de verwijzende bron—Dit kan ofwel de titel of een algemene onderwerpverwijzing zijn. Als het een hoofdstuktitel of een kop is, zet het dan tussen aanhalingstekens; als het de naam is van een boek, tijdschrift, rapport of naslagwerk, zet het dan in cursief. (Individuele artikel titels gaan ook tussen aanhalingstekens.)
• Pagina nummer—Vereist als het zich in hetzelfde document bevindt. Als de kruisverwijzing naar het begin van een hoofdstuk gaat en het hoofdstuknummer en de titel worden vermeld (zij het intern of extern), is het paginanummer niet nodig. Lezers kunnen de inhoudsopgave gebruiken. Als de kruisverwijzing een kop bevat die intern in een genummerd hoofdstuk voorkomt, vermeld dan het paginanummer waar die kop voorkomt.
• Onderwerp van de kruisverwijzing—Vaak moet je aangeven wat er in het kruisverwezen materiaal staat en uitleggen waarom de lezer de moeite moet nemen om het te bekijken. Dit kan vereisen dat je het onderwerp van het kruisverwezen materiaal aangeeft of expliciet zegt hoe het verband houdt met de huidige discussie.

Deze richtlijnen worden weergegeven in de volgende illustratie. Let op in die illustratie hoe verschillend de regels zijn wanneer de kruisverwijzing "intern" is (dat wil zeggen, naar een ander deel van hetzelfde document) in vergelijking met wanneer het "extern" is (naar informatie buiten het document).

Voorbeelden van Koppelverwijzingen

Interne kruisverwijzingen zijn kruisverwijzingen naar andere gebieden binnen hetzelfde document; externe verwijzingen zijn die naar informatierecources buiten uw document.

Toelichtende Formuleringen in Doorverwijzingen

Het is onhandig en frustrerend om dergelijke kruisverwijzingen tegen te komen: (zie Fig. 3)

Lezers moeten weten waar het kruisverwijs materiaal over gaat, en waarom ze ernaar moeten kijken.

Ze hebben ook slechts een kort idee nodig van hoe ze de interne cross-referentietekst, afbeeldingen, tabel, grafiek of diagram—kunnen begrijpen, slechts een aanwijzing. Hier is een voorbeeld (er is een grijze achtergrond toegevoegd aan de cross-referentietekst):

Lithium wordt geëxtraheerd via twee belangrijke methoden: traditionele open-pit mijnbouwtechnieken en zoutwaterextractie [6]. Zoals weergegeven in Figuur 3, vertegenwoordigen pegmatieten 26% van de wereldwijde lithiumbronnen, terwijl zoutwater 66% vertegenwoordigt [6]. Figuur 3. Percentage van de wereldwijde lithiumreserves per type [6].

Zodra de pekel in een verdampingsvijver de ideale lithiumconcentratie heeft bereikt, wordt de pekel naar een lithiumherstelinstallatie gepompt voor verdere verwerking en extractie. De resterende pekeloplossing wordt teruggebracht naar het ondergrondse reservoir [9]. Figuur 5 toont de schaal van een typisch lithiumverdampingsmeer systeem. Let op de grootte van de wegen en nutsvoorzieningen voor schaal. Figuur 5. Lithium verdampingsvijvers [10]. Voorbeeld van een verklarende kruisverwijzing. Bron: James Ball.

Hier is nog een voorbeeld; de grijze achtergrond is niet in het origineel:

Open Pit Mijnbouw. Pegmatiet wordt gewonnen uit open mijnen met traditionele mijnbouwtechnieken. De gewonnen brokken pegmatiet worden vervolgens mechanisch vergruisd om hun grootte te verkleinen. Het vergruisde erts wordt verder gemalen om een fijner product te produceren, dat geschikter is voor verdere scheiding. De verwerking resulteert in een concentraat dat chemisch wordt verwerkt om lithiumcarbonaat of lithiumhydroxide te creëren [3]. Figuur 4 toont een voorbeeld van een openlucht lithium mijn die de typische schaal van deze operaties weergeeft. Figuur 4. Openlucht lithium mijn [7]. Voorbeeld van een verklarende kruisverwijzing. Bron: James Ball.

Gerelateerde informatie

Lezen quiz. Gebruik deze quiz om je begrip van dit hoofdstuk te testen.

Training beschikbaar. Oefen met schrijven met McMurrey als uw instructeur.

Ik zou uw gedachten, reacties, kritiek over dit hoofdstuk op prijs stellen: je reactie.