Een snippet is een herbruikbaar blok van inhoud: tekst, alinea's, tabellen, afbeeldingen, callouts, codeblokken of elke combinatie die je één keer maakt en in meerdere artikelen invoegt. Wanneer je een fragment bijwerkt, wordt de wijziging automatisch weergegeven in elk artikel dat het gebruikt. Fragmenten worden opgeslagen in een centrale bibliotheek binnen Document360 en zijn onzichtbaar als een apart element voor lezers. Op de kennisbanksite wordt snippet-inhoud weergegeven als gewone artikelinhoud.
Waarom snippets gebruiken
Snippets pakken een veelvoorkomend documentatieprobleem aan: inhoud die in meerdere artikelen voorkomt, moet op meerdere plaatsen worden bijgehouden. Zonder snippets betekent het bijwerken van een productdisclaimer, een supportcontactblokkade of een gedeelde waarschuwing dat je elk artikel dat het bevat moet vinden en elk afzonderlijk moet bewerken. Een gemiste instantie leidt tot inconsistente informatie.
Met fragmenten leeft die inhoud op één plek:
- Enkele bron van waarheid. Eén edit, overal consistente updates.
- Minder onderhoudskosten. Geen zoeken tussen artikelen naar herhaalde inhoud.
- Consistentie op grote schaal. Dezelfde waarschuwing, notitie of stap verschijnt identiek in alle artikelen.
- Sneller schrijven. Schrijvers voegen vooraf gedefinieerde blokken in in plaats van opnieuw te typen of te kopiëren en plakken.
Fragmenten versus variabelen
Document360 biedt twee tools voor hergebruik van content. Het kiezen van de juiste hangt af van wat je hergebruikt.
| Fragmenten | Variabelen | |
|---|---|---|
| Inhoudstype | Opgemaakte blokken zoals alinea's, tabellen, afbeeldingen, callouts en code. | Platte tekstwaarden zoals namen, cijfers, URL's en korte zinnen. |
| Typisch gebruik | Disclaimers, gedeelde stappen, contactblokkades, herhaalde waarschuwingen. | Productnamen, versienummers, support-e-mailadressen. |
| Tekenlimiet | Geen tekenlimiet. | 300 tekens. |
| Kan het opmaak bevatten? | Ja, volledige editor-opmaak. | Nee, alleen sms. |
| Kun je andere snippets nesten? | Ja, alleen Markdown-fragmenten. | Nee. |
| Ingevoegd via | Werkbalk- of samenvoegcodesyntaxis. | Werkbalk, samenvoegcodesyntaxis, of slash-commando. |
Begin met Snippets
Maak en beheer snippets
Maak een snippet, kies je editor, gebruik Eddy AI tijdens het draften en beheer snippets vanaf de snippets-pagina — bewerken, verwijderen, bulk verwijderen en afhankelijkheden bekijken.
Lees meer →Gebruik en vertaal fragmenten
Voeg fragmenten in artikelen in met drie methoden, vertaal fragmenten voor meertalige kennisbanken en los veelvoorkomende problemen op.
Lees meer →Best practices
- Gebruik fragmenten voor inhoud die in drie of meer artikelen voorkomt. Als hetzelfde blok maar op één of twee plekken voorkomt, is het eenvoudiger om die direct te bewerken dan het maken en beheren van een snippet.
- Houd elk fragment gericht op één doel. Een fragment dat één specifieke functie vervult, zoals een disclaimer, een contactblokkade of een gedeelde waarschuwing, is makkelijker te hergebruiken en bij te werken dan een fragment dat niet-gerelateerde content samenvoegt.
- Noem fragmenten beschrijvend. Gebruik bijvoorbeeld een naamgevingspatroon dat het type en doel van de inhoud weerspiegelt, bijvoorbeeld
[Warning] Unsaved changesof[Contact] Support block. Consistente namen maken de bibliotheek gemakkelijk te scannen en verkleinen de kans dat het verkeerde fragment wordt ingevoegd. - Controleer afhankelijkheden voordat je bewerkt of verwijdert. Wijzigingen in een snippet gelden direct voor alle artikelen die het gebruiken, inclusief gepubliceerde artikelen. Gebruik de kolom 'Gebruikt in' om de impact te bekijken voordat je wijzigingen aanbrengt.
- Gebruik geen variabelen in snippets. Variabelen in snippets worden niet correct weergegeven in de editor-preview of in PDF-exports. Beheer dynamische waarden los van snippetcontent.
- Vertaal fragmenten naast artikelen. Als je kennisbank meerdere talen ondersteunt, vertaal dan fragmenten tegelijk met de artikelen die ze gebruiken. Een fragment zonder vertaling toont de standaard taalwaarde aan lezers in andere locaties.