Bijdragen aan VaultPAM Help Center
Deze richtlijn legt uit hoe u artikelen in het VaultPAM Help Center schrijft en bewerkt. Het behandelt stem en toon, artikelstructuur, schermafbeeldingsconventies en het PR-proces. U hebt geen lokale ontwikkelomgeving nodig om een wijziging voor te stellen — de GitHub webeditor is voldoende voor de meeste bewerkingen.
1. Stem en toon
Schrijf voor het operator-persona: een professional die dagelijks bevoorrechte toegang beheert en snel nauwkeurige, taakgeoriënteerde antwoorden nodig heeft. De schrijfstijl volgt deze principes:
- Taakgericht. Begin met het doel van de gebruiker, niet met achtergrondtheorie. Plaats het "wat" en "hoe" voor het "waarom".
- Tweede persoon. Spreek de lezer aan als "u". Vermijd "de gebruiker" of "men zou".
- Actieve vorm. "Klik op Verbinden" niet "De knop Verbinden moet worden aangeklikt".
- Duidelijke taal. Gebruik korte zinnen. Vermijd jargon tenzij het VaultPAM-specifieke terminologie is die al een Concepts-artikel heeft.
- Inclusief. Vermijd idiomatische uitdrukkingen die niet goed vertalen. Schrijf op een manier die even goed werkt voor sprekers van Engels als eerste en tweede taal.
- Specifiek. Noem exacte UI-elementen in vet (
**Opslaan**, Connectors-tabblad). Voeg exacte foutmeldingen toe in codeblokken.
Persona-kaart
| Persona | Wie zij zijn | Toenverschuiving |
|---|---|---|
| Evaluator | Net ingelogd; eerste sessie | Extra begeleiding; voeg "Voordat u begint" checklists toe |
| Operator | Dagelijkse gebruiker; sessies starten, goedkeuringen | Beknopt; ze kennen het product |
| Admin | Organisaties, beleid, MFA configureren | Nauwkeurig; ze hebben exacte veldnamen en waarden nodig |
| Self-hosted Admin | Admin achter een firewall | Noteer offline-beperkingen; flag cloud-only functies |
| Support Engineer | Tickets oplossen | Diep linkbare secties; voeg exacte foutcodes in |
2. Artikelstructuur
Elk artikel moet het frontmatter-blok bevatten en de onderstaande sectievolorde volgen.
Frontmatter (verplicht)
---
title: Kort, imperatief titel (bijv. "Een Connector verbinden")
description: Eénzinssamenvatting voor SEO en de zoekindex.
persona: operator # een van: evaluator, operator, admin, self-hosted-admin, support
category: how-to # een van: get-started, how-to, concepts, reference, troubleshooting, release-notes, security-compliance, admin
last_reviewed: "YYYY-MM-DD"
applies_to_versions: ["v1"]
keywords: [connector, rdp, session]
---
Alle zes velden zijn verplicht. De build-pipeline geeft een waarschuwing voor ontbrekende velden. Zodra de workflow voor het samenstellen geoptimaliseerd is, zal de CI-gate waarschuwingen als fouten behandelen.
Sectievolorde
- Titel (H1) — komt overeen met de frontmatter
title. - Korte samenvattingsparagraaf — 1–3 zinnen: wat de lezer zal bereiken en wanneer dit artikel te gebruiken. Geen H2-kop.
- Voordat u begint (optioneel H2) — vereisten, vereiste machtigingen, koppelingen naar setupartikelen. Gebruik een checklist (
- [ ]). - Stappen (H2 voor elke grote taak) — genummerde stappen (
1.,2., …). Één actie per stap. Plaats het verwachte resultaat aan het einde van een stap wanneer het niet duidelijk is. - Probleemoplossing (optioneel H2) — lijst met "Probleem / Oplossing"-paren. Gebruik een definitielijststijl of een tabel.
- Gerelateerde artikelen (optioneel H2) — 3–5 bullet-koppelingen naar gerelateerde documentatie. Gebruik site-relatieve koppelingen (
[Een Safe toevoegen](/how-to/add-safe)enzovoort).
Voorbeeld-skelet
---
title: Een sessieverzoek goedkeuren
description: Een binnenkomend RDP-sessiegoedkeuringverzoek in VaultPAM goedkeuren of weigeren.
persona: operator
category: how-to
last_reviewed: "2026-05-12"
applies_to_versions: ["v1"]
keywords: [approval, session, rdp]
---
# Een sessieverzoek goedkeuren
Wanneer een gebruiker een RDP-sessie aanvraagt waarvoor goedkeuring vereist is, ontvangt u een melding in VaultPAM. Dit artikel laat zien hoe u dat verzoek controleert en goedkeurt of weigert.
## Voordat u begint
- [ ] U hebt de rol **Approver** in de relevante Safe.
- [ ] Het sessieverzoek is niet verlopen (standaard TTL: 10 minuten).
## Het verzoek goedkeuren
1. Open **VaultPAM** en klik op **Approvals** in de zijbalk.
2. Zoek het verzoek in behandeling en klik op **Review**.
3. Controleer de velden **Target**, **Requester** en **Justification**.
4. Klik op **Approve** of **Reject**.
De aanvrager ontvangt onmiddellijk een melding in de app.
## Probleemoplossing
**Het menu Approvals ontbreekt.**
U hebt geen Approver-rol. Vraag uw VaultPAM-beheerder om u als goedkeurder toe te voegen op de relevante Safe.
## Gerelateerde artikelen
- [Wat is een Safe?](/concepts/what-is-a-safe)
- [Een sessieverzoek goedkeuren](/how-to/approve-session)
- [Een opname delen](/how-to/share-recording)
3. Schermafbeeldingsconventies
Schermafbeeldingen helpen operators het juiste UI-element in één oogopslag te herkennen. Volg deze regels om schermafbeeldingen onderhoudbaar en toegankelijk te houden.
| Regel | Detail |
|---|---|
| Indeling | Alleen PNG. Gebruik geen JPEG of WebP (compressiefouten maken UI-tekst onduidelijk). |
| Maximale breedte | 1024 px. Exporteer met 1x pixeldichtheid (niet 2x/Retina) om bestandsgrootte onder 200 KB te houden. |
| Nauw bijsnijden | Toon alleen het relevante gebied. Vermijd volledige browserschermafbeeldingen tenzij de volledige viewport-context nodig is. |
| Gevoelige gegevens maskeren | Vervagen of vervang alle zichtbare hostnamen, IP-adressen, gebruikersnamen of tokens. Gebruik een effen kleurvak, geen tekstoverlay. |
| Alt-tekst | Verplicht op elke afbeelding. Beschrijf wat de schermafbeelding toont, niet wat u wilt dat de lezer doet. Voorbeeld: Schermafbeelding van het Approvals-paneel met één verzoek in behandeling en een Approve-knop. |
| Bestandsnaamgeving | [article-slug]-[step-number]-[short-label].png, bijv. connect-connector-01-enrollment-token.png. |
| Opslagpad | Plaats afbeeldingen in docs/help/img/[article-slug]/. |
Afbeelding-markdown
4. PR-proces
Optie A — Bewerken via GitHub-webeditor (aanbevolen voor inhoudsonlywijzigingen)
Elk gepubliceerd artikel heeft een Edit this page-koppeling onderaan. Door erop te klikken, opent de GitHub-webeditor met het juiste bestand en de juiste branch.
- Klik op Edit this page onderaan het artikel.
- Breng uw wijzigingen aan in de editor.
- Schrijf in het paneel Propose changes een korte commit-bericht (bijv.
fix typo in session approval steps). - Klik op Propose changes → Create pull request.
- Stel in het PR-formulier de titel in om de wijziging te beschrijven (bijv.
Fix typo in approve-session article). Geen issue-sleutel vereist voor pure inhoudsverstrekking. - Dien de PR in. Er wordt automatisch een preview-opmerking geplaatst met de PR-gerelateerde dev-docs URL op
https://dev.euwarden.com/docs/pr-<n>/— de koppeling verschijnt binnen enkele minuten op de PR.
Optie B — Branch van een Jira-issue (voor gestructureerd feature- of redesignwerk)
Wanneer een wijziging in het help center wordt bijgehouden onder een Jira-issue (bijv. een nieuw artikel toevoegen gekoppeld aan een feature-release):
- Branchnaam:
AIC-XXXX-help-<slug>(bijv.AIC-1234-help-connector-offline-guide). - Commit-berichtprefix:
AIC-XXXX: <description>. - PR-titel:
[AIC-XXXX] Add connector-offline troubleshooting article.
PR's alleen voor docs (geen codewijzigingen) kunnen rechtstreeks naar main gaan. Jira-issue-sleutel is optioneel voor typo-/formuleringsverstrekking.
Beoordeling en samenvoegen
CODEOWNERS vraagt automatisch om beoordeling van @OWL-Management/product-analysts en @OWL-Management/pm voor alle PR's die docs/help/** wijzigen. Een PR moet minstens één goedkeuring ontvangen voordat deze kan worden samengevoegd.
Review SLA: content reviewers streven ernaar binnen 2 werkdagen te reageren. Als een PR urgent is (bijv. het oplossen van een ondersteuningsblokkerend onnauwkeurigheid), voeg het label help-urgent toe en ping het kanaal #docs Slack.
Preview-URL
Elke PR die docs/help/** of docs-site/** wijzigt, activeert een preview-build. CI plaatst de PR-gerelateerde dev-docs URL (https://dev.euwarden.com/docs/pr-<n>/) als sticky PR-opmerking binnen ongeveer 3 minuten.
Preview-omgevingen worden niet geïndexeerd door zoekmachines (meta-tag noindex is ingesteld).
5. Checklist voordat u een PR indient
- Frontmatter heeft alle zes verplichte velden:
title,description,persona,category,last_reviewed,applies_to_versions. -
last_reviewedis de datum van vandaag. - Alle schermafbeeldingen zijn PNG, max 1024 px breed, met alt-tekst.
- Gevoelige gegevens in schermafbeeldingen zijn gemaskeerd.
- Koppelingen volgen de sectievolorde (geen H1 in een stapblok).
- Interne koppelingen gebruiken site-relatieve paden (beginnen met
/). - Geen verbroken koppelingen (Docusaurus-build geeft waarschuwing voor verbroken koppelingen).
- Preview-URL gecontroleerd en artikel weergegeven correct.