Συνεισφορά στο VaultPAM Help Center
Ο παρών οδηγός εξηγεί τον τρόπο συγγραφής και επεξεργασίας άρθρων στο VaultPAM Help Center. Καλύπτει τη φωνή και τον τόνο, τη δομή του άρθρου, τις συμβάσεις στιγμιότυπων και τη διαδικασία PR. Δεν χρειάζεστε τοπικό περιβάλλον ανάπτυξης για να προτείνετε μια αλλαγή — ο επεξεργαστής GitHub στον ιστό είναι επαρκής για την πλειοψηφία των επεξεργασιών.
1. Φωνή και τόνος
Γράφετε για την προφίλ του χειριστή: ένας επαγγελματίας που διαχειρίζεται την προνομιακή πρόσβαση καθημερινά και χρειάζεται ακριβείς, προσανατολισμένες σε εργασίες απαντήσεις γρήγορα. Το στυλ γραφής ακολουθεί τις ακόλουθες αρχές:
- Προσανατολισμένο σε εργασίες. Ξεκινήστε με τον στόχο του χρήστη, όχι με τη θεωρητική ανασκόπηση. Τοποθετήστε το "τι" και το "πώς" πριν από το "γιατί".
- Δεύτερο πρόσωπο. Απευθυνθείτε στον αναγνώστη ως "εσείς". Αποφύγετε το "ο χρήστης" ή "θα έπρεπε κανείς".
- Ενεργητική φωνή. "Κάντε κλικ στο Connect" και όχι "Το κουμπί Connect θα πρέπει να γίνει κλικ".
- Απλή γλώσσα. Προτιμήστε σύντομες προτάσεις. Αποφύγετε τη ζαργόν εκτός αν είναι VaultPAM-ειδική ορολογία που έχει ήδη ένα άρθρο Concepts.
- Ένταξη. Αποφύγετε τα ιδιώματα που δεν μεταφράζονται καλά. Γράφετε με τρόπο που λειτουργεί εξίσου για τους ομιλητές της αγγλικής ως πρώτης και δεύτερης γλώσσας.
- Συγκεκριμένο. Ονοματίστε ακριβή στοιχεία UI με έντονα (
**Save**,**Connectors**tab). Συμπεριλάβετε ακριβή μηνύματα σφάλματος σε μπλοκ κώδικα.
Χάρτης προφίλ
| Προφίλ | Ποιοι είναι | Αλλαγή τόνου |
|---|---|---|
| Evaluator | Μόλις έγινε εγγραφή· πρώτη συνεδρία | Επιπλέον καθοδήγηση· προσθέστε λίστες ελέγχου "Πριν ξεκινήσετε" |
| Operator | Καθημερινός χρήστης· εκκίνηση συνεδριών, έγκριση | Σύντομη· γνωρίζουν το προϊόν |
| Admin | Διαμόρφωση οργανισμών, πολιτικών, MFA | Ακριβής· χρειάζονται ακριβή ονόματα και τιμές πεδίων |
| Self-hosted Admin | Admin πίσω από τείχος προστασίας | Σημειώστε περιορισμούς χωρίς σύνδεση· σημάνετε τις δυνατότητες που προορίζονται μόνο για cloud |
| Support Engineer | Επίλυση εισιτηρίων | Τμήματα με βαθιά σύνδεση· συμπεριλάβετε ακριβή κωδικά σφάλματος |
2. Δομή άρθρου
Κάθε άρθρο πρέπει να περιλαμβάνει το μπλοκ frontmatter και να ακολουθεί τη σειρά τμήματος παρακάτω.
Frontmatter (απαιτείται)
---
title: Short, imperative title (e.g., "Connect a Connector")
description: One-sentence summary for SEO and the search index.
persona: operator # one of: evaluator, operator, admin, self-hosted-admin, support
category: how-to # one of: 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]
---
Και τα έξι πεδία είναι υποχρεωτικά. Ο αγωγός κατασκευής εκδίδει μια προειδοποίηση για οποιοδήποτε ελλιπές πεδίο. Μόλις ο ροή εργασίας συγγραφής ωριμάσει, η πύλη CI θα αντιμετωπίζει τις προειδοποιήσεις ως σφάλματα.
Σειρά τμήματος
- Τίτλος (H1) — ταιριάζει με το frontmatter
title. - Σύντομη περίληψη παραγράφου — 1–3 προτάσεις: τι θα επιτύχει ο αναγνώστης και πότε να χρησιμοποιήσει αυτό το άρθρο. Χωρίς H2 επικεφαλίδα.
- Πριν ξεκινήσετε (προαιρετική H2) — προαπαιτούμενα, απαιτούμενα δικαιώματα, σύνδεσμοι σε άρθρα ρύθμισης. Χρησιμοποιήστε λίστα ελέγχου (
- [ ]). - Βήματα (H2 για κάθε κύρια εργασία) — αριθμημένα βήματα (
1.,2., …). Μία ενέργεια ανά βήμα. Βάλτε το αναμενόμενο αποτέλεσμα στο τέλος ενός βήματος όταν δεν είναι προφανές. - Αντιμετώπιση προβλημάτων (προαιρετική H2) — λίστα ζευγών "Πρόβλημα / Λύση". Χρησιμοποιήστε στυλ λίστας ορισμού ή πίνακα.
- Σχετικά άρθρα (προαιρετική H2) — 3–5 κουλοχέρια σύνδεσμοι στα σχετικά έγγραφα. Χρησιμοποιήστε σχετικούς σύνδεσμους ιστοτόπου (
[Add a Safe](/how-to/add-safe)κ.λπ.).
Σκελετός παραδείγματος
---
title: Approve a Session Request
description: How to approve or reject an incoming RDP session approval request in VaultPAM.
persona: operator
category: how-to
last_reviewed: "2026-05-12"
applies_to_versions: ["v1"]
keywords: [approval, session, rdp]
---
# Approve a Session Request
When a user requests an RDP session that requires approval, you receive a notification in VaultPAM. This article shows you how to review and approve or reject that request.
## Before you begin
- [ ] You have the **Approver** role in the relevant Safe.
- [ ] The session request has not expired (default TTL: 10 minutes).
## Approve the request
1. Open **VaultPAM** and click **Approvals** in the sidebar.
2. Locate the pending request and click **Review**.
3. Check the **Target**, **Requester**, and **Justification** fields.
4. Click **Approve** or **Reject**.
The requester receives an in-app notification immediately.
## Troubleshooting
**The Approvals menu is missing.**
You do not have the Approver role. Ask your VaultPAM admin to add you as an approver on the relevant Safe.
## Related articles
- [What is a Safe?](/concepts/what-is-a-safe)
- [Approve a pending session](/how-to/approve-session)
- [Share a recording](/how-to/share-recording)
3. Συμβάσεις στιγμιότυπων
Τα στιγμιότυπα βοηθούν τους χειριστές να αναγνωρίσουν το σωστό στοιχείο UI με μια ματιά. Ακολουθήστε αυτούς τους κανόνες για να διατηρήσετε τα στιγμιότυπα διαχειρίσιμα και προσβάσιμα.
| Κανόνας | Λεπτομέρεια |
|---|---|
| Μορφή | Μόνο PNG. Μην χρησιμοποιείτε JPEG ή WebP (τα τεχνουργήματα συμπίεσης σκοτώνουν το κείμενο UI). |
| Μέγιστο πλάτος | 1024 px. Εξαγάγετε με πυκνότητα πικσέλ 1x (όχι 2x/Retina) για να διατηρήσετε το μέγεθος αρχείου κάτω από 200 KB. |
| Κόψτε σφιχτά | Εμφανίστε μόνο τη σχετική περιοχή. Αποφύγετε πλήρη στιγμιότυπα περιηγητή εκτός αν απαιτείται το πλήρες πλαίσιο προβολής. |
| Μάσκα ευαίσθητα δεδομένα | Θολώστε ή αντικαταστήστε τυχόν ονόματα κεντρικών υπολογιστών, διευθύνσεις IP, ονόματα χρήστη ή διακριτικά ορατά στο στιγμιότυπο. Χρησιμοποιήστε ένα πλαίσιο στερεού χρώματος, όχι επικάλυψη κειμένου. |
| Εναλλακτικό κείμενο | Απαιτείται σε κάθε εικόνα. Περιγράψτε τι δείχνει το στιγμιότυπο, όχι τι θέλετε ο αναγνώστης να κάνει. Παράδειγμα: Screenshot of the Approvals panel showing one pending request with an Approve button. |
| Ονοματοδοσία αρχείου | [article-slug]-[step-number]-[short-label].png, π.χ., connect-connector-01-enrollment-token.png. |
| Διαδρομή αποθήκευσης | Τοποθετήστε εικόνες σε docs/help/img/[article-slug]/. |
Markdown εικόνας
4. Διαδικασία PR
Επιλογή A — Επεξεργασία μέσω του επεξεργαστή ιστού GitHub (συνιστώμενο για αλλαγές που αφορούν μόνο περιεχόμενο)
Κάθε δημοσιευμένο άρθρο έχει έναν σύνδεσμο Edit this page στο κάτω μέρος. Κάνοντας κλικ σε αυτό, ανοίγεται ο επεξεργαστής ιστού GitHub προ-γεμάτος με το σωστό αρχείο και κλάδο.
- Κάντε κλικ στο Edit this page στο κάτω μέρος του άρθρου.
- Κάντε τις αλλαγές σας στον επεξεργαστή.
- Στο πάνελ Propose changes, γράψτε ένα σύντομο μήνυμα commit (π.χ.,
fix typo in session approval steps). - Κάντε κλικ στο Propose changes → Create pull request.
- Στη φόρμα PR, ορίστε τον τίτλο για να περιγράψετε την αλλαγή (π.χ.,
Fix typo in approve-session article). Δεν απαιτείται κλειδί έκδοσης για αμιγείς διορθώσεις περιεχομένου. - Υποβάλετε το PR. Ένα σχόλιο προεπισκόπησης δημοσιεύεται αυτόματα με τη σχετική URL των εγγράφων dev
https://dev.euwarden.com/docs/pr-<n>/— ο σύνδεσμος εμφανίζεται στο PR μέσα σε λίγα λεπτά.
Επιλογή B — Κλάδος από ένα ζήτημα Jira (για δομημένη εργασία δυνατοτήτων ή αναδιαμόρφωσης)
Όταν μια αλλαγή help-center παρακολουθείται σύμφωνα με ένα ζήτημα Jira (π.χ., προσθήκη ενός νέου άρθρου συνδεδεμένου με μια έκδοση δυνατότητας):
- Όνομα κλάδου:
AIC-XXXX-help-<slug>(π.χ.,AIC-1234-help-connector-offline-guide). - Πρόθεμα μηνύματος commit:
AIC-XXXX: <description>. - Τίτλος PR:
[AIC-XXXX] Add connector-offline troubleshooting article.
Τα PR που αφορούν μόνο έγγραφα (χωρίς αλλαγές κώδικα) ενδέχεται να στοχεύουν απευθείας στο main. Το κλειδί ζητήματος Jira είναι προαιρετικό για διορθώσεις τυπογραφικών σφαλμάτων/διατύπωσης.
Αναθεώρηση και συγχώνευση
Το CODEOWNERS αυτόματα ζητά αναθεώρηση από τους @OWL-Management/product-analysts και @OWL-Management/pm για όλα τα PR που αγγίζουν το docs/help/**. Ένα PR πρέπει να λάβει τουλάχιστον μία έγκριση πριν μπορέσει να συγχωνευθεί.
SLA αναθεώρησης: οι κριτικοί περιεχομένου στοχεύουν να αποκριθούν εντός 2 εργάσιμων ημερών. Εάν ένα PR είναι επείγον (π.χ., διόρθωση μιας ανακρίβειας που μπλοκάρει την υποστήριξη), προσθέστε την ετικέτα help-urgent και ετοιμάστε το κανάλι #docs Slack.
URL προεπισκόπησης
Κάθε PR που τροποποιεί docs/help/** ή docs-site/** ενεργοποιεί μια κατασκευή προεπισκόπησης. Η CI δημοσιεύει τη σχετική URL των εγγράφων dev PR (https://dev.euwarden.com/docs/pr-<n>/) ως σχόλιο σταθερό PR σε περίπου 3 λεπτά.
Τα περιβάλλοντα προεπισκόπησης δεν ευρετηριάζονται από τις μηχανές αναζήτησης (ορίστηκε η μετα-ετικέτα noindex).
5. Λίστα ελέγχου πριν υποβάλετε ένα PR
- Το frontmatter έχει και τα έξι απαιτούμενα πεδία:
title,description,persona,category,last_reviewed,applies_to_versions. - Το
last_reviewedείναι σημερινή ημερομηνία. - Όλα τα στιγμιότυπα είναι PNG, μέγ. 1024 px πλάτος, με εναλλακτικό κείμενο.
- Τα ευαίσθητα δεδομένα στα στιγμιότυπα είναι μασκαρισμένα.
- Οι επικεφαλίδες ακολουθούν τη σειρά του τμήματος (χωρίς H1 μέσα σε ένα μπλοκ βήματος).
- Οι εσωτερικοί σύνδεσμοι χρησιμοποιούν σχετικές διαδρομές ιστοτόπου (ξεκινούν με
/). - Χωρίς σπασμένους συνδέσμους (η κατασκευή Docusaurus θα προειδοποιήσει σχετικά με σπασμένους συνδέσμους).
- URL προεπισκόπησης ελεγμένο και άρθρο εμφανίζεται σωστά.