Documentation Index
Fetch the complete documentation index at: https://docs.oasecreative.nl/llms.txt
Use this file to discover all available pages before exploring further.
Overzicht
Dit playbook beschrijft het volledige interne proces voor het ontwikkelen van handleidingen bij Oase Creative. Wij leveren twee soorten handleidingen:- Grafische handleidingen (PDF / print / design)
- Online handleidingen (Mintlify documentatie) Beide trajecten starten met een volledige intake en het verzamelen van alle benodigde assets.
Deel 1: Grafische Handleidingen (PDF / Design)
Stap 1: Intakeformulier via Slack
Klanten vullen een uitgebreid formulier in. Het formulier moet volledig zijn voordat wij starten.Formulier moet bevatten:
- Titel van de handleiding
- Doelgroep
- Doel van de handleiding
- Verwachte lengte in pagina’s
- Branding (logo’s, kleuren, typografie)
- Voorbeeldhandleidingen / moodboards
- Afbeeldingen, iconen of diagrammen
- Teksten of ruwe content
- Vereiste talen
- Vorm van oplevering (PDF / print-ready / digitaal)
Acties:
- Formulier controleren
- Ontbrekende assets opvragen
- Alles opslaan in Google Drive
- Slack-update: intake compleet
Stap 2: Designfase
Wanneer alle assets compleet zijn start de designer met het ontwerp.Designer werkt aan:
- Structuur & lay-out
- Pagina-indeling
- Iconografie & visuals
- Typografie
- Kleurgebruik
- Diagrammen, schema’s, tabellen
- Branding volgens klantidentiteit
Output:
- Eerste ontwerpversie (PDF)
Stap 3: Eerste versie naar klant
Projectmanager stuurt naar klant:- PDF-voorbeeld
- Verzoek om revisies gebundeld aan te leveren
Revisies:
- 1 revisieronde inbegrepen
- Extra revisies → meerwerk
Stap 4: Revisies verwerken
Designer werkt revisies uit:- Visuele verbeteringen
- Contentaanpassingen
- Correcties op iconen / visuals
Stap 5: Final Delivery (Grafisch)
Oplevering bevat:
- Final PDF
- Optioneel: bronbestanden
- Drive-map met alle assets
- Eventuele meertalige versies Extra talen kunnen sneller worden ingebouwd door onze interne automatisaties.
Deel 2: Online Handleidingen (Mintlify)
Stap 1: Technische Setup
Wij bouwen online documentatie via:- GitHub (structuur & versiebeheer)
- Mintlify (UI, hosting & documentatiebeheer)
Acties:
- Nieuwe GitHub-repository opzetten
- Mintlify-account maken voor klant
- GitHub ↔ Mintlify koppeling activeren
- Slack-kanaal starten voor het project
Stap 2: Discoverygesprek met klant
Een overleg waarin wordt bepaald:- Doel van de documentatie
- Structuur (hoofdstukken, secties, sidebar)
- Doelgroepen (klanten, gebruikers, developers)
- Branding voor Mintlify
- Taal/talen
- Integraties (API docs, changelog, guides)
- Automatisaties (AI search, auto-indexing)
Stap 3: Verzamelen van content & assets
Samen met de klant verzamelen we:- Teksten
- Screenshots
- Video’s
- Diagrammen
- Tabellen
- Functiebeschrijvingen
- Tutorials & stappenplannen
- FAQ’s Alles wordt opgeslagen in Drive én GitHub.
Stap 4: Inbouwwerk in Mintlify
Taken:
- Sidebar structuren
- Pagina’s bouwen in Markdown
- Screenshots inbouwen
- Video’s insluiten
- Code snippets toevoegen (indien developer-docs)
- Meertalige structuur opzetten:
/nl/.../en/.../de/...Mintlify ondersteunt meertalige duplicatie waardoor dit efficiënt gaat.
Stap 5: Eerste Versie Publiceren
De eerste versie wordt geplaatst op een Mintlify preview-omgeving.Acties:
- Slack-update met preview-url
- Walkthrough-call met klant
Stap 6: Revisies verwerken
Klant levert één gebundelde revisielijst aan.Revisies bevatten:
- Tekstcorrecties
- Structuuraanpassingen
- Nieuwe screenshots
- Nieuwe secties
- Correcties op design 1 revisieronde inbegrepen.
Stap 7: Final Delivery (Mintlify)
Oplevering bevat:
- Live Mintlify documentatie
- GitHub-repository volledig ingericht
- Branding & navigatie compleet
- Meertalige versies (indien van toepassing)
- Video-uitleg voor beheer (optioneel)
Best Practices
Voor grafische handleidingen:
- Gebruik veel visuals
- Werk modulair per sectie
- Gebruik consistente iconen
- Houd tekst compact en scanbaar
- Bundel alle feedback in één document
Voor Mintlify:
- Houd pagina’s kort en modulair
- Gebruik duidelijke bestandsnamen
- Documenteer altijd met voorbeelden
- Gebruik AI Search & metadata
- Maak gebruik van meertalige duplicatie
Samenvatting Workflow (Grafisch)
- Intake compleet
- Assets verzamelen
- Designfase
- Eerste versie
- Revisies
- Final PDF
Samenvatting Workflow (Mintlify)
- GitHub + Mintlify setup
- Discoverygesprek
- Content verzamelen
- Inbouw
- Eerste versie online
- Revisies
- Final delivery