Variabelen zijn herbruikbare tekstelementen waarmee je een waarde één keer kunt definiëren en deze kunt invoegen over meerdere artikelen en categoriepagina's. Wanneer de waarde verandert, werk je de variabele op één plek bij en elk artikel dat deze gebruikt wordt automatisch bijgewerkt.
Als je support-e-mail bijvoorbeeld in 40 artikelen en wijzigingen verschijnt, wordt de variabele één keer bijgewerkt en alle 40 artikelen direct bijgewerkt.
Wanneer variabelen te gebruiken
Gebruik variabelen voor korte, tekstgebaseerde inhoud die:
- Komt voor in meerdere artikelen of categoriepagina's.
- Zal waarschijnlijk in de loop van de tijd veranderen, zoals contactgegevens, versienummers, productnamen, URL's, veldlabels of disclaimers.
- Moet consistent blijven over de hele kennisbasis.
Voor langere of geformatteerde inhoud zoals alinea's, tabellen, callouts of afbeeldingen, gebruik in plaats daarvan Snippets .
Variabelen versus fragmenten
| Variabelen | Fragmenten | |
|---|---|---|
| Inhoudstype | Platte tekst, cijfers, links, korte zinnen. | Opgemaakte blokken zoals alinea's, tabellen, afbeeldingen, callouts en code. |
| Typisch gebruik | Productnamen, versienummers, support-e-mails. | Disclaimers, gedeelde stappen, contactblokkades, herhaalde waarschuwingen. |
| Tekenlimiet | 300 tekens. | Geen tekenlimiet. |
| Ondersteuning voor opmaak | Alleen basis inline opmaak. | Volledige editor-opmaak. |
| Ingevoegd via | Werkbalk, samenvoegcodesyntaxis, of slash-commando. | Werkbalk- of samenvoegcodesyntaxis. |
Begin met variabelen
Variabelen creëren en beheren
Maak een variabele aan en configureer de naam, mergecode, taal en inhoud ervan. Bewerken, verwijderen, bulk verwijderen en artikelafhankelijkheden bekijken.
Lees meer →Gebruik en vertaal variabelen
Voeg variabelen in artikelen in met behulp van de werkbalk, samenvoegcodesyntaxis of het schuine streep-commando. Variabelen vertalen voor meertalige kennisbanken.
Lees meer →Best practices
- Gebruik variabelen voor inhoud die verandert, niet voor content die vast blijft. Variabelen zijn het meest waardevol wanneer de inhoud periodiek moet worden bijgewerkt. Als een waarde waarschijnlijk niet zal veranderen, is het eenvoudiger en makkelijker om deze inline te schrijven.
- Gebruik alleen variabelen wanneer dezelfde inhoud op drie of meer plaatsen voorkomt. Als iets slechts in één of twee artikelen voorkomt, is het direct bijwerken daarvan sneller dan het aanmaken en beheren van een variabele.
- Gebruik beschrijvende, specifieke namen. Noem variabelen zodat bijdragers in één oogopslag de juiste kunnen identificeren. Bijvoorbeeld,
SupportEmailofProductVersion_iOSis duidelijker danemail1ofv1. Vage namen vertragen het schrijven en leiden ertoe dat de verkeerde variabele wordt ingevoegd. - Stel de taalscope bewust in. Gebruik Global voor waarden die in elke taal hetzelfde zijn, zoals een productnaam die nooit wordt vertaald. Gebruik taalspecifieke variabelen voor waarden die per locatie verschillen, zoals een regionaal telefoonnummer of een gelokaliseerde URL.
- Controleer de kolom 'Gebruikt in' voordat je bewerkt of verwijdert. Een bewerking aan een variabele werkt elk artikel dat het gebruikt direct bij, inclusief gepubliceerde exemplaren. Bekijk voordat je een wijziging aanbrengt welke artikelen worden beïnvloed zodat je kunt verifiëren dat de bijgewerkte waarde in alle contexten correct leest.
- Gebruik geen variabelen in snippets. Variabelen in snippets worden niet correct weergegeven in de editor-preview of in PDF-exports. Als een snippet dynamische waarden nodig heeft, beheer ze dan apart.