Categorieën

In Document360 heeft elke categorie een type dat bepaalt hoe deze eruitziet en zich gedraagt op zowel het kennisbankportaal als de kennisbanksite. Het kiezen van het juiste type helpt je een duidelijke, navigeerbare structuur voor je lezers op te bouwen. Er zijn vier categorieën: Map, Index, Page en GitHub.

Categorietypen in één oogopslag

Map

Het Map-type is het standaard en meest gebruikte categorietype. Het fungeert als een pure container, waarbij artikelen en subcategorieën worden gegroepeerd onder een gemeenschappelijk onderwerp zonder een eigen URL of inhoudspagina op de kennisbank te genereren.

Gebruik Map wanneer:

• Je hebt een top-level groepering nodig voor een breed onderwerp.
• De categorie heeft geen deelbare link nodig.
• Je wilt dat lezers navigeren naar subcategorieën of artikelen in plaats van op een categoriepagina te landen.

Belangrijke kenmerken:

• Er wordt geen URL gegenereerd voor dit categorietype.
• Ondersteunt bulkoperaties: Verbergen (), Ontmaskeren (), Verwijderen (), Verplaatsen (), en Ster () voor artikelen binnen de categorie.
• Het categorie-icoon kan worden aangepast met een emoji.

Index

Het type Index genereert zijn eigen URL en toont een gestructureerd overzicht van alle artikelen binnen de categorie. Wanneer lezers op een Indexcategorie op de kennisbanksite klikken, zien ze een lijst met artikelen, inclusief titel, bijdragers, laatst bijgewerkte datum, status en tags, voordat ze een specifiek artikel openen.

Gebruik Index wanneer:

• Je wilt dat lezers een overzicht krijgen van de inhoud van een categorie voordat ze erin duiken.
• De categorie heeft een deelbare, linkbare URL nodig.
• Je hebt een gestructureerd instappunt nodig voor een groot deel van je kennisbasis.

Belangrijke kenmerken:

• Er wordt een unieke slug gegenereerd. Je kunt links naar de Indexcategorie delen en daar doorverwijzingsregels op toepassen.
• Ondersteunt dezelfde bulkbewerkingen als Map: Verbergen, Ontmaskeren, Verwijderen, Verplaatsen en Steren.
• Ondersteunt SEO-instellingen (metatitel, slug, beschrijving) via het More ()-icoon > SEO.

Portaalweergave:

Kennisbank-siteweergave:

Wanneer lezers op een Indexcategorie klikken, zien ze de categorietitel en het aantal artikelen en subcategorieën dat deze bevat.

Page

Het paginatype gedraagt zich als een gewoon artikel. Je kunt er content in schrijven, formatteren en publiceren met de Markdown-, WYSIWYG- of Advanced WYSIWYG-editor. Het kan nog steeds subcategorieën en artikelen eronder bevatten, waardoor het geschikt is voor sectielandingspagina's die ook als navigatieouders dienen.

Gebruik Page wanneer:

• Je wilt een categorie met eigen geschreven inhoud, zoals een sectieoverzicht of inleiding.
• Je hebt volledige artikelfunctionaliteit nodig (SEO-instellingen, slug, status, revisiegeschiedenis) op categorieniveau.
• De categorie moet zowel inhoud bevatten als als ouder voor subcategorieën fungeren.

Belangrijke kenmerken:

• Gedraagt zich precies als een gewoon artikel. Je kunt de titel, slug en alle dezelfde artikel-niveau acties wijzigen.
• Ondersteunt SEO-instellingen via het More ()-icoon > SEO.
• In tegenstelling tot een regulier artikel kan een paginacategorie subcategorieën en extra artikelen eronder bevatten.

Portaalweergave:

Kennisbank-siteweergave:

GitHub

Het type GitHub synchroniseert documentatie-inhoud rechtstreeks van een verbonden GitHub-repository naar je kennisbank. Elke tak in de repository verschijnt als een artikel binnen de categorie, geïdentificeerd door een branch-icoon. Telkens wanneer een commit naar de verbonden repository wordt gepusht, haalt Document360 automatisch de bijgewerkte Markdown-bestanden op en publiceert ze.

Gebruik GitHub wanneer:

• Je documentatie staat naast je code in een GitHub-repository en wordt onderhouden in GitHub.
• Je wilt versiebeheerde documentatie die automatisch synchroon blijft met codereleases.
• Je team schrijft Markdown liever in een lokale editor dan in de Document360-editor.

Belangrijke kenmerken:

• Content die gesynchroniseerd is vanaf GitHub is alleen-lezen in Document360. Alle bewerkingen moeten worden uitgevoerd in de bron-GitHub-repository.
• Alleen de hoofdtak wordt ondersteund voor synchronisatie.
• Elke tak in de verbonden repository verschijnt als een artikel met een branch-icoon in het portaal.
• Gebruikers kunnen geen artikelen bewerken of publiceren in een GitHub-categorie. Alle wijzigingen moeten afkomstig zijn uit de GitHub-repository.
• Het GitHub-icoon wordt alleen weergegeven voor publieke categorieën.
• Nieuwe artikelen kunnen niet worden aangemaakt binnen Document360 voor door GitHub-gesynchroniseerde categorieën.

Categorieën vergelijken

Verander het categorietype

Je kunt op elk moment het type van een categorie wisselen zonder content te verliezen.

1. Navigeer naar Documentatie () in de linker navigatiebalk.
2. Beweeg met de muis over de categorie in het venster Categorieën & Artikelen .
3. Klik op het More () icoon en selecteer Type wijzigen.
4. Selecteer het nieuwe categorietype en klik op Update.

Best practices

• Gebruik Map voor top-level categorieën die puur voor navigatie bestaan. Het is het eenvoudigste type en genereert geen onnodige URL's.
• Gebruik Index voor grote secties waar lezers profiteren van het zien van een artikeloverzicht voordat ze doorzoeken, bijvoorbeeld een API-referentie of een lange handleiding voor probleemoplossing.
• Gebruik de pagina voor sectie-landingspagina's die inleidende inhoud nodig hebben naast kindartikelen, bijvoorbeeld een "Getting started"-pagina die de sectie uitlegt en links naar kindartikelen geeft.
• Gebruik GitHub alleen wanneer je documentatie actief wordt onderhouden in een repository en je automatische synchronisatie nodig hebt, niet voor eenmalige imports.
• Vermijd frequente typewisselingen bij drukbezochte categorieën. Omzetten naar Page laat de categorie in conceptstaat achter, wat kan leiden tot kapotte links totdat ze gepubliceerd worden.

FAQ