Dokumentation Guidelines

Wie schreibe ich einen guten Artikel für die discoverize Branchenportal Dokumentation?

Aufbau eines Artikels

1. Teil 1: Kurze Einführung zum Ziel: Warum soll ich mich mit diesem Feature beschäftigen? Was kann ich mit dieser Funktion erreichen?
   1-2 Sätze
   Teil 1.1. – optional: Bei Bedarf das Ziel in einem eigenen Absatz mit Überschrift weiter ausbauen.
2. Teil 2: Ziel erreichen: Wie stelle ich das ein? Was muss ich machen?
3. Teil 3: Wie sieht das Ergebnis aus?

Semantik – welche Begriffe verwenden wir?

1. Branchenportal
2. Software
3. Portal Management oder Verwaltung?
4. Portal Betreiber
5. „Unternehmen“ oder im Bezug auf Premium auch „Kunde“ (anstatt Eintragsbetreiber)
6. Besucher
7. E-Mails, Domais, etc. (z.B. in Screenshots) immer discoverize.com und @discoverize.com verwenden

Weitere (technische) Tipps

1. SEO: „Branchenportal“ und „Software“ sind unserer primären Keywords – diese auf natürliche Weise in Überschriften, URL-Slug (optional) und Fließtext einbauen
2. Formatierung für einfacheren Textkonsum: Verwenden von Überschriften (ab H2), Listen, usw.
3. Hervorhebung von Schlagwörtern durch fett
4. So viel wie möglich auf vorhandene Inhalte verlinken
5. Bilder und Screenshots verwenden: je selbsterklärender, desto besser, bei Bedarf animierte Gifs für komplexe Abläufe
6. Kontext auf Bildern zeigen: Wenn möglich Navigation, Subnavigation, Header zeigen: Wo bin ich hier eigentlich?
7. Screenshots mit einheitlichem Aussehen: Screenpresso nutzen, grüne Pfeile (5px pen width), Nummern, Rechtecke:
   
8. Bilder sollten für bessere Lesbarkeit der Texte als PNG gespeichert werden.
9. Bilder sollten ca. 820px breit und Inhalte noch wahrnehmbar sein, optimaler Weise lesbar
10. Bilder mit Alt-Tag und Title versehen: Keyword setzen, Bild beschreiben
11. Seite verorten: Rechte Navigation -> Page Attributes -> Parent -> unterhalb von Dokumentation den passenden Parent wählen
    
12. Template auswählen: Rechte Sidebar -> Template -> Docs Page
    
13. bei zu langen Titeln für das Menu: Titel kürzen und lange Fassung in die Description unten einfügen:
    
    Die Description wird für die Überschrift im Content verwendet. Der Titel für das Menu, die Crumbtrails und die Links unter dem Artikel.

Abnahme von Artikeln

1. Korrektur Lesen
2. Verortung und Sidebar prüfen
3. Links prüfen
4. Screenshot Inhalte prüfen: Bei E-Mails immer „@discoverize.com“