Zum Hauptinhalt springen

Redaktionsleitfaden – heycreo Hilfe-Center

Dieses Dokument ist verbindlich für alle Artikel im Hilfe-Center.
Ziel: konsistente Sprache, klare Struktur, kein durchdringendes Entwickler-Vokabular.


1. Haltung & Ton

Wir sprechen per „du"

heycreo duzt alle Nutzerinnen und Nutzer – konsequent, ohne Ausnahme.

Wir schreiben für Menschen, nicht für Suchmaschinen

Kein aufgeblähtes Intro, keine SEO-Phrasen wie „In diesem Artikel erfahren Sie…". Stattdessen: Direkt zum Punkt. Die erste Zeile eines Artikels beantwortet die Frage.

Wir erklären, aber bevormunden nicht

Gut: „Klicke auf Fertigstellen. heycreo rendert alle Formate automatisch."
Schlecht: „Du solltest unbedingt auf den Fertigstellen-Button klicken, damit der Render-Prozess angestoßen wird."

Wir vermeiden Prosa, wo Listen klarer sind

Schritte immer nummeriert. Optionen/Alternativen immer als Liste.


2. Artikeltypen (einhalten!)

Jeder Artikel ist genau einem Typ zugeordnet. Typen nicht mischen.

TypWannAufbau
Schritt-für-SchrittNutzer möchte eine Aufgabe erledigenIntro (1–2 Sätze), Voraussetzungen, numm. Schritte, nächste Schritte
KonzeptNutzer möchte verstehen, was etwas istDefinition, warum es existiert, Grenzen, Beispiel
ReferenzNutzer sucht Einstellungswert, Limit, FormatTabelle oder Liste, keine Erzählung
FehlerbehebungNutzer hat ein ProblemSymptom, warum es passiert, Lösung(en)
FAQEinzelne Frage, kurze AntwortFrage als H2, Antwort direkt darunter

3. Artikelstruktur (Schritt-für-Schritt)

---
title: "Verb + Objekt" ← z. B. "Neues Design erstellen"
sidebar_label: "Design erstellen"
---

<!-- 1 Satz: Was macht dieser Artikel? -->
Hier erstellst du ein neues Design aus einer Vorlage.

<!-- Optional: Hinweis-Box, wenn Voraussetzung kritisch -->
:::info[Voraussetzung]
Das Brand Kit muss bereits eingerichtet sein. → [Brand Kit einrichten](../einrichten/brand-kit)
:::

## Schritt-für-Schritt
<Steps>
<Step title="Designs öffnen">…</Step>
<Step title="Vorlage wählen">…</Step>
</Steps>

## Nächste Schritte
<Cards>…</Cards>

Regeln:

  • Titel = Verb + Objekt (infinitiv). Kein „Wie man…", kein „Anleitung zu…"
  • Maximal 5–7 Hauptschritte. Mehr = Artikel aufteilen.
  • Jeder Schritt ist in sich abgeschlossen: Aktion → erwartetes Ergebnis.
  • UI-Labels immer fett und genau so wie in der App. Kein Paraphrasieren.

4. Sprache & Stil

Aktiv statt Passiv

  • ✅ „Klicke auf Speichern."
  • ❌ „Der Speichern-Button muss geklickt werden."

Präsens

  • ✅ „heycreo rendert alle Formate automatisch."
  • ❌ „heycreo wird alle Formate automatisch rendern."

Keine Nominalisierungen

  • ✅ „Wähle ein Format."
  • ❌ „Nimm eine Formatauswahl vor."

Kurze Sätze

Faustregel: Kein Satz länger als 20 Wörter. Bei komplexen Sachverhalten aufteilen.

Keine Redundanzen

  • ❌ „Klicke auf den Button Speichern, um zu speichern."
  • ✅ „Klicke auf Speichern."

Kein Gedankenstrich als Listenergänzung

Das Muster [Link](url) — Beschreibung ist das verbreitetste KI-Stilmuster überhaupt. Nicht verwenden.

  • - [Brand Kit einrichten](./brand-kit) — Logos und Farben hinterlegen
  • - [Brand Kit einrichten](./brand-kit) (Titel reicht)
  • ✅ Oder als Satz: „Wer noch kein Brand Kit hat, richtet es zuerst unter Brand Kit einrichten ein."

Gedankenstriche mitten im Satz ersetzen: entweder durch Komma, durch einen Doppelpunkt oder durch zwei Sätze.


5. Offizielle Terminologie (aus den i18n-Dateien)

Regel: Was in der App steht, steht auch in der Doku. Weder erfinden noch umschreiben.
Hier die autoritativen Begriffe – Abweichungen sind Fehler.

App-LabelKorrekt in der Doku❌ Nicht verwenden
DesignsDesignsPosts, Creatives
MedienMedienAssets, Media Library
Planer / Content-PlanerContent-PlanerScheduler, Planner
StudioStudioTemplate-Editor, Editor
Brand EngineBrand EngineTemplate Generator
VorgängeVorgängeCases, Tickets
ReviewsReviewsApprovals
Brand CentralBrand CentralAdmin Portal
DashboardDashboardÜbersicht, Start
WorkspaceWorkspaceOrganisation, Firma, Mandant

Einstellungen & Verwaltung

App-LabelKorrekt in der Doku❌ Nicht verwenden
Brand KitBrand KitMarken-Kit, Branding
FarbpalettenFarbpalettenColor Palettes
SchriftartenSchriftartenFonts (als Substantiv allein)
Format-PresetsFormat-PresetsFormate (wenn Presets gemeint)
Freigaben / FreigabeFreigabeApproval, Genehmigung
Rollen & RechteRollen & RechtePermissions, Berechtigungen
NutzungNutzungUsage, Limits

Team & Zugriff

App-LabelKorrekt in der Doku❌ Nicht verwenden
AdministratorAdministrator (oder Admin)Admin-User, Super-User
PublisherPublisherVeröffentlicher
MitarbeiterMitarbeiterStaff, Viewer
Teammitglied einladeneinladenhinzufügen (für Personen)

Designs & Editor

App-LabelKorrekt in der Doku❌ Nicht verwenden
VorlageVorlageTemplate (als deutsches Wort)
SteuerelementSteuerelementControl, Widget, Field
SichtbarkeitssteuerungSichtbarkeitssteuerungVisibility Condition
Erweiterte BedingungenErweiterte BedingungenAdvanced Conditions
Keyframe-AnimationKeyframe-AnimationTimeline-Animation
VersionshistorieVersionshistorieVersion History
Neue Größe hinzufügenNeue Größe hinzufügenNeues Format (im Editor-Kontext)

Export & Druck

App-LabelKorrekt in der Doku❌ Nicht verwenden
DruckdatenDruckdatenPrepress-Daten, Print-Ready
DruckvorstufeDruckvorstufePrepress
PDFPDFDruckdatei (ohne weiteres)
Rendern & HerunterladenHerunterladen / ExportierenDownload triggern

Medien & KI

App-LabelKorrekt in der Doku❌ Nicht verwenden
MedienMedienDAM (in Prosa)
KI-Agent / heycreo-AgentKI-AssistentAI Agent, Bot
Bild-CreditsBild-CreditsImage Credits
Agent MemoryAgent MemoryKnowledge Base, Kontext

Social & Veröffentlichen

App-LabelKorrekt in der Doku❌ Nicht verwenden
Verbundene AccountsVerbundene AccountsSocial Connections
Verbindenverbindenconnecten, koppeln
Trennentrennendisconnecten
Veröffentlichenveröffentlichenpublishen, posten (als Verb)

6. Verbotene Begriffe (interne Namen / Code-Artefakte)

Diese Begriffe kommen aus dem Code und dürfen nie in Nutzer-sichtbaren Artikeln erscheinen:

Interner NameNutzer-sichtbarer Begriff
post / posts (Entity)Design / Designs
asset / assetsMedium / Medien
prepressDruckvorstufe
organization / orgWorkspace (aus Nutzersicht)
slug(nur technisch, nicht erklären)
templateVorlage
render (als Verb)exportieren / verarbeiten
case / casesVorgang / Vorgänge
approvalFreigabe
publisher (Rolle)Publisher (ok als Rollenname)
staff (Rolle)Mitarbeiter
collectionOrdner (im Designs/Medien-Kontext)

7. Formatierung im Artikel

UI-Labels

Immer fett, genau wie in der App:
„Klicke auf Neues Design → wähle eine Vorlage → klicke auf Öffnen."

Pfade / Menüabfolgen

Mit → verknüpft (kein >):
„Einstellungen → Brand Kit → Logos"

Hinweis-Boxen (sparsam einsetzen)

:::tip
Kurzer Profi-Tipp, der den Workflow verbessert.
:::

:::info
Voraussetzung oder kontextueller Hinweis.
:::

:::warning
Etwas, das schiefgehen kann oder irreversibel ist.
:::

Screenshots

  • Noch nicht verfügbar (Phase 2).
  • Platzhalter: ![Bezeichnung](placeholder.png) mit aussagekräftigem Alt-Text.

Tabellen

Nur für Referenz-Artikel (Einstellungen, Formate, Limits). Nicht in Schritt-für-Schritt-Artikeln.


8. Was einen billigen KI-Artikel von einem guten unterscheidet

Erkennungsmerkmale eines schlechten Artikels

  • Beginnt mit „In diesem Artikel lernst du…" oder „Willkommen beim…"
  • Nennt denselben Sachverhalt in 3 verschiedenen Phrasen (Padding)
  • Erklärt Offensichtliches: „Klicke auf den Button, um die Aktion auszuführen"
  • Vage Schritt-Beschreibungen ohne konkreten UI-Bezug
  • Interne Namen aus dem Code (post, asset, prepress)
  • Übertriebene Schachtelung: „Gehe zu Einstellungen, dann klicke dort auf …, dann …"
  • Fehlerhafte Terminologie (mal „Vorlage", mal „Template", mal „Muster")
  • Kein konkretes Ergebnis pro Schritt

Merkmale eines guten Artikels

  • Erste Zeile = Antwort auf die Frage oder das Ergebnis der Aufgabe
  • Jeder Schritt: Aktion (Verb + UI-Label) + erwartetes Ergebnis
  • Konsistente Begriffe von Zeile 1 bis zum letzten Satz
  • Voraussetzungen stehen vor den Schritten, nicht mittendrin
  • Keine unnötigen Füllwörter; jeder Satz hat einen Informationswert
  • Links zu verwandten Artikeln am Ende (kein Link-Spam im Text)
  • Wenn etwas schiefgehen kann, steht es in einer Warning-Box – nicht verschämt im letzten Absatz

9. Checkliste vor Veröffentlichung

  • Titel ist ein Verb + Objekt (Infinitiv)
  • Artikel ist genau einem Typ zugeordnet
  • Alle UI-Labels sind fett und stimmen mit der App überein
  • Kein interner Code-Name verwendet (post, asset, prepress, slug, etc.)
  • Jeder Schritt hat eine Aktion und ein erwartetes Ergebnis
  • Keine Sätze länger als 20 Wörter (grobe Prüfung)
  • Voraussetzungen kommen vor Schritt 1
  • „Nächste Schritte" oder verwandte Artikel am Ende vorhanden