SUMO: Tipps und Vorgaben zum Erstellen von Artikeln

Sie möchten Firefox unterstützen? Hier finden Sie Informationen, wie Sie sich beteiligen können.

Moderator: Lendo

SUMO: Tipps und Vorgaben zum Erstellen von Artikeln

Beitragvon Lendo » Do, 16. Okt 2008 0:09

Diese Tipps sind als Hilfe für all jene gedacht, die auf SUMO Artikel vervollständigen, korrigieren oder neu erstellen möchten.

Einstieg für Mithelfende zu SUMO:
Helfer-Startseite

Grundlegende Einführung, wie Hilfedokumente verfasst werden müssen:
So werden Artikel für die Wissensdatenbank geschrieben

Liste der Formatierungen, die auf SUMO möglich sind:
Syntax-Übersicht

Hintergrundinfos zu SUMO:
Wie die Wissensdatenbank funktioniert

Auf erweiterungen.de - Informationen für Übersetzer findest du in den Abschnitten Rechtschreibung/Grammatik bis Benutzerfreundlichkeit/Eindeutigkeit weitere Grundregeln für Übersetzer, die auch auf SUMO zutreffen.



Was muss ich konkret beachten?

  1. Vorlagen/dynamische Inhalte
    Wenn ein Text, der bearbeitet werden soll, nicht auffindbar ist und stattdessen etwas Seltsames wie
    Code: Alles auswählen
    [[Template:OnlyVersionX|4]]
    dort steht, handelt es sich um Vorlagen von SUMO. Eine Vorlage ist ein vordefinierter, immer wieder gebrauchter Textblock, der in allen Artikeln eingebunden werden kann.

    Der Vorteil von Vorlagen ist, dass diese Textblöcke nur ein einziges Mal erstellt (und geändert) werden müssen, auch wenn sie in vielen Artikeln vorkommen. Also nutze sie!

    Weitere Infos zu Vorlagen!


  2. Betriebssystem- und versionsspezifische Anpassungen
    Rechts vom Artikelinhalt gibt es immer 2 Auswahlmöglichkeiten, die z.B. folgendes Zeigen
    Hilfe zu:
    * Windows
    * Mac OS X
    * Linux
    * Android

    * Firefox 4
    * Firefox 3.5-3.6

    Es handelt sich um das For-System, das es ermöglicht, einen einzigen Artikel gleichzeitig für verschiedene Betriebssysteme und Firefox-Versionen zu schreiben. Ein Mehraufwand durch unterschiedliche Artikel für das selbe Problem fällt dadurch weg.
    Beim Übersetzen von Artikeln stößt du dann auf Auszeichnungen wie:
    Code: Alles auswählen
    {for win,fx4}Dieser Text ist ein Beispiel und nur für Firefox 4 auf Windows gedacht.{/for}
    Lasse die {...}-Elemente selbst unangetastet und übersetze nur den Textinhalt ─ aber bitte so, dass es auf Deutsch Sinn ergibt. Oft kann man den englischen Text nicht 1:1 übertragen.

    Weitere Infos zum For-System!


  3. Sie, du und man
    Niemals Du in Hilfeartikeln verwenden!
    Auf SUMO verwenden wir ausschließlich das höfliche Sie (mit groß geschriebenem S).

    In einer Hilfe den Lesenden immer direkt und deutlich ansprechen:
    - keine "man"-Sätze,
    - nicht drumherum reden, sondern direkt ansprechen,
    - Passivsätze vermeiden,
    - Sätze mit soll(te), könnte usw. vermeiden.

    Beispiele:
    - Sie statt du: Öffnen Sie ... statt Öffne ...
    - Kein man: Klicken Sie auf ... statt Man klickt auf ...
    - Direkt ansprechen: Löschen Sie das. statt Man muss das löschen.
    - Kein Passiv: Ändern Sie das. statt Das muss geändert werden.
    - Keine Ungenauigkeiten: Machen Sie das so. statt Das soll(te) so gemacht werden.


  4. Verständlich schreiben
    - Vermeide Abkürzungen und verwende sie nur, wenn sie allgemein bekannt sind (erlaubt ist beispielsweise "z.B." ohne Leerzeichen dazwischen).
    - Technische (Internet-)Fachausdrücke nur verwenden, wenn sie am Anfang des Artikels erklärt werden.
    - Verschachtelte Sätze vermeiden und stattdessen lieber mehrere kurze Sätze nehmen.
    - Stelle dir den Leser als unerfahrenen, kurz angebundenen Firefox-Nutzer vor, der kein technisches Hintergrundwissen hat, der selten mit Computern zu tun hat und der gerade ungeduldig ist und keine Zeit hat (niemand liest gern viel).
    - Möglichst deutschsprachige Begriffe verwenden, da die Hauptzielgruppe nicht-technikaffine Firefox-Nutzer aller Altersklassen ist (z.B. Rechner statt PC/Computer, (Benutzer-)Konto statt Account, anmelden statt einloggen usw.).


  5. Einheitlichen Stil wahren
    - Wahre einen einheitlichen Stil und misch z.B. nicht usw. und etc. in einem Artikel ─ wir verwenden usw. in der Firefox-Hilfe.
    - Verwende möglichst gleiche Satzkonstrukte und variiere nicht zu viel. Das erleichtert das schnelle Lesen der Artikel.
    - Verwende „ („) und “ (“) als Anführungszeichen statt der englischen ".." oder des Apostrophs (').
    - Verwende den Gedankenstrich – (–) bei Einschüben oder Gedankenpausen anstatt des normalen Bindestrichs/Viertelgeviertstrichs (‐) oder anstatt des langen Gedankenstrichs (—), welcher in engl. Texten verwendet wird.


  6. SUMO-interne Verknüpfungen
    Originaltexte von Verknüpfungen in zweifacher eckiger Klammer [[...]] belassen und niemals übersetzen!
    (Einer Verknüpfung kann man einen anderen Titel geben mit [[Link|neuer Titel]].)
    Das sind interne Links auf andere SUMO-Artikel.

    Gibt es zu dem verknüpften Artikel noch keine deutschsprachige Übersetzung, erscheint der englische Titel, z.B. [[Profiles]]. Wenn dieser Artikel dann ins Deutsche übersetzt wird, z.B. "Benutzerprofile", wird der Titel im deutschsprachigen Artikel automatisch auf deutsch angezeigt. Im Quelltext bleibt er englisch.
    So erspart man sich nachträgliches manuelles Umbenennen, wenn der Artikeltitel geändert wird.


  7. Übersetzungen immer mit dem Original abgleichen
    Das erstmalige Übersetzen, das Fertigstellen der Übersetzung, das Korrekturlesen und das endgültige Freischalten eines Artikels kann eine Weile dauern. Es ist nicht ungewöhnlich, dass zwischenzeitlich das englische Original verändert wurde.
    Beim Korrekturlesen bitte vor allem auch mit dem Original vergleichen und schauen, ob bei der Übersetzung Inhalte fehlen oder anders übersetzt sind, als sie im Original beschrieben stehen.


  8. Wo beginne ich mit dem Übersetzen?
    Wir übersetzen vorrangig Artikel, die bevorzugt gelesen/benötigt werden. Damit vergeuden wir unsere beschränkten Ressourcen nicht mit dem Übersetzen relativ überflüssiger Artikel.

    Als Anhaltspunkt, welche Artikel übersetzt werden sollten, können folgenden Listen angesehen werden:

Überschriften in Deutsch und Englisch (gestrichen, da es bei SUMO diese Funktionalität seit dem Umstieg auf die Kitsune-Software nicht mehr gibt):
Damit wir nicht immer alle Verweise auf bestimmte Kapitel (Unterüberschriften) eines Artikels übersetzen/anpassen müssen, ist es sinnvoll, den Originaltext der Überschrift in in der Form {ANAME()}Englischer Überschriftenname{ANAME} zu behalten:
Code: Alles auswählen
{ANAME()}What is history?{ANAME}
!Was beinhaltet die Chronik?


Bildbenennnung (gestrichen, da SUMO die Bilder jetzt mit fortlaufenden Nummern einfügt):
Es gibt (noch) keine offiziellen Vorgaben, weswegen wir folgende Namenskonvention einführen: de + _ + (verkürzter) Titel des Artikels + _ + Bildbeschreibung - Alles klein schreiben und ohne Leer- und Sonderzeichen! Beispiele: de_bitdefender_einstellungen.png oder de_benutzerprofile_ordnerstruktur-windows.png

[*]Einige Artikel brauchen nicht übersetzt zu werden
Es gibt Artikel auf SUMO, die möglicherweise gelöscht werden. Diese müssen natürlich nicht übersetzt werden. Die Artikel, die auf folgenden Seiten angegeben sind, bitte nicht übersetzen:

SUMO-Übersetzungsübersicht: Welche sind die wichtigsten Artikel, die als nächstes übersetzt werden sollen?
[*][SUMO] Was können wir als nächstes übersetzen?
[*]Alle nicht übersetzten Artikel auf [SUMO] Weekly common issues
[*]Die "beliebten Hilfe-Artikel" auf der Startseite von SUMO
[*]Alle nicht-deutschsprachigen Artikel der Liste der "Top Artikel"
Zuletzt geändert von Lendo am So, 17. Jul 2011 23:45, insgesamt 9-mal geändert.
Benutzeravatar
Lendo
Moderator
 
Beiträge: 1540
Registriert: Fr, 07. Okt 2005 16:07
Wohnort:

Beitragvon NightHawk56 » Do, 16. Okt 2008 3:59

Hi folks,

in Anlehnung an den Thread "Suche Screenshots von Personal Firewalls für SUMO [fertig]" mal die Frage:
    ist es wegen
    Lendos (Beitrag) hat geschrieben:[...] Auch eine Art Bilderdatenbank gibt es (noch) nicht, wo man nachsehen und Bilder umbenennen könnte. [...]
    sinnvoll, generell eigene Bilder hochzuladen oder kann man davon ausgehen, dass vorhandenes Bildmaterial auch weiterhin zur Verfügung steht? Oder kann man gefahrlos in anderen Artikeln nach geeignetem Bildmaterial suchen und dieses verlinken?

Have fun,
NightHawk
NightHawk56
Senior-Mitglied
 
Beiträge: 9973
Registriert: Sa, 26. Feb 2005 13:44

Beitragvon Boersenfeger » Do, 16. Okt 2008 12:39

Danke Lendo, sehr hilfreich. Teilweise habe ich dagegen
SUMO-interne Verknüpfungen:

verstoßen. Mal sehen ob ich alles wiederfinde, oder wird das in der Staging Area ausgebügelt?
Stand 18.6.2013
Mozilla/5.0 (Windows NT 6.1; WOW64; rv:21.0) /20100101 Firefox/21.0
Mozilla/5.0 (Windows NT 6.1; WOW64; rv:22.0) /20130612 Firefox/22.0b5
Mozilla/5.0 (Windows NT 6.1; WOW64; rv:23.0) /20131617 Firefox/23.0a2
Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:24.0) /20130617 Firefox/24.0

Meine Füchse|Fehlersuche|Anleitung für Fragen im Forum|Sicherheitskonzept für Windowsnutzer
Benutzeravatar
Boersenfeger
Senior-Mitglied
 
Beiträge: 32990
Registriert: So, 21. Mär 2004 13:21
Wohnort: Fussball-Bundesliga-Stadt Braunschweig

Beitragvon deschen2 » Do, 16. Okt 2008 15:15

Klasse Sache Lendo. Werd' mir heute abend mal die ganzen Links zu Gemüte führen. Teilweise habe ich bei "meinen" Artikeln nämlich nicht wirklich alle Hinweise beachtet (aus Unkenntnis heraus).

Der Thread ist doch sicher wieder was zum Anpinnen. Ich werd' mal Road-Runner Bescheid sagen.

MfG...
Benutzeravatar
deschen2
Senior-Mitglied
 
Beiträge: 4101
Registriert: Mo, 27. Mär 2006 16:24
Wohnort: Mainz

Beitragvon Lendo » Sa, 18. Okt 2008 0:13

NightHawk,
derzeit ist es noch nicht möglich, Bilder zu entfernen, die einmal hochgeladen sind. Auch ein Überschreiben der Bilder ist nicht möglich (korrigiert mich bitte, wenn es doch möglich wäre!). Bilder sind trotzdem weiter verfügbar, auch wenn sie nicht in einem Artikel verwendet wurden, nachdem sie hochgeladen wurden (korrigiert mich bitte, wenn es doch möglich wäre!). Und man kann natürlich schon hochgeladene Bilder aus anderen Artikeln wiederverwenden. (Am einfachsten dazu den Quelltext der betreffenden Seiten ansehen - Link "Quelle" - und den Bilderquelltext rauskopieren.)

Überschreiben der Bilder doch möglich! (Fux bestätigt dies 2 Kommentare weiter unten)

Boersenfeger,
automatisch wird nichts ausgebügelt. Ich habe wahrscheinlich auch nicht alle Eigenbenennungen von (())-Verknüpfungen korrigiert.
Zuletzt geändert von Lendo am Sa, 18. Okt 2008 2:45, insgesamt 2-mal geändert.
Benutzeravatar
Lendo
Moderator
 
Beiträge: 1540
Registriert: Fr, 07. Okt 2005 16:07
Wohnort:

Beitragvon deschen2 » Sa, 18. Okt 2008 0:37

Ähm...kann sein, dass ich mich irre, aber ich glaube, ich habe bei meiner ersten Übersetzung mal ein Bild hochgeladen, sagen wir xyz.png. Danach habe ich diese Bild glaube ich nochmal verändert und unter demselben Namen erneut hochgeladen. Meinst du das mit "Überschreiben"?

Aber wie gesagt...meine Erinnerung täuscht mich bei sowas gern mal. Bei meiner nächsten Übersetzung werde ich das Verhalten aber mal provozieren, um das Verhalten zu testen!

MfG...
Benutzeravatar
deschen2
Senior-Mitglied
 
Beiträge: 4101
Registriert: Mo, 27. Mär 2006 16:24
Wohnort: Mainz

Beitragvon Fux » Sa, 18. Okt 2008 2:11

Lendo hat geschrieben:Auch ein Überschreiben der Bilder ist nicht möglich (korrigiert mich bitte, wenn es doch möglich wäre!).


Ich hab' das einmal gemacht und es hat geklappt, Bild gleichen Namens in der Vorschau angehängt und damit war das andere überschrieben.
Schönen Gruß, Fux

Bild
Bitte keine technischen Anfragen per Mail oder PN, sie werden definitiv nicht beantwortet.
Benutzeravatar
Fux
Site Admin
 
Beiträge: 1269
Registriert: Do, 01. Jul 2004 16:43
Wohnort: Freiburg

Beitragvon Boersenfeger » Sa, 18. Okt 2008 10:32

Lendo hat geschrieben:Boersenfeger,
automatisch wird nichts ausgebügelt. Ich habe wahrscheinlich auch nicht alle Eigenbenennungen von (())-Verknüpfungen korrigiert.
Soll, darf man dann die Verknüpfungen umbenennen, wenn bereits die Verknüpfung in DEUTSCH vorliegt, oder nicht?
Stand 18.6.2013
Mozilla/5.0 (Windows NT 6.1; WOW64; rv:21.0) /20100101 Firefox/21.0
Mozilla/5.0 (Windows NT 6.1; WOW64; rv:22.0) /20130612 Firefox/22.0b5
Mozilla/5.0 (Windows NT 6.1; WOW64; rv:23.0) /20131617 Firefox/23.0a2
Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:24.0) /20130617 Firefox/24.0

Meine Füchse|Fehlersuche|Anleitung für Fragen im Forum|Sicherheitskonzept für Windowsnutzer
Benutzeravatar
Boersenfeger
Senior-Mitglied
 
Beiträge: 32990
Registriert: So, 21. Mär 2004 13:21
Wohnort: Fussball-Bundesliga-Stadt Braunschweig

Beitragvon deschen2 » Sa, 18. Okt 2008 11:43

Boersenfeger hat geschrieben:
Lendo hat geschrieben:Boersenfeger,
automatisch wird nichts ausgebügelt. Ich habe wahrscheinlich auch nicht alle Eigenbenennungen von (())-Verknüpfungen korrigiert.
Soll, darf man dann die Verknüpfungen umbenennen, wenn bereits die Verknüpfung in DEUTSCH vorliegt, oder nicht?


Naja, ich habe es bisher so gemacht: wenn der zu verlinkende Artikel noch nicht auf Deutsch verfügbar ist, habe ich ihn so verlinkt:

((this is only a test|Dies ist nur ein Test))


Damit wird der Linkname deutsch angezeigt, verlinkt aber auf den englischen Artikel.

Wenn nun der Artikel übersetzt wird, kann man sich das ja sparen und abändern zu:

Code: Alles auswählen
((Dies ist nur ein Test))


MfG...
Benutzeravatar
deschen2
Senior-Mitglied
 
Beiträge: 4101
Registriert: Mo, 27. Mär 2006 16:24
Wohnort: Mainz

Beitragvon Lendo » Sa, 18. Okt 2008 18:12

Boersenfeger hat geschrieben:
Lendo hat geschrieben:Boersenfeger,
automatisch wird nichts ausgebügelt. Ich habe wahrscheinlich auch nicht alle Eigenbenennungen von (())-Verknüpfungen korrigiert.
Soll, darf man dann die Verknüpfungen umbenennen, wenn bereits die Verknüpfung in DEUTSCH vorliegt, oder nicht?
Generall würde ich vorschlagen, alle SUMO-internen Artikeltitel englisch zu belassen. Dann sieht man, welcher Artikel schon übersetzt ist und welcher nicht.

Ist es aber zum Verständnis des Textes unbedingt erforderlich, den Artikeltitel zu übersetzen, damit sich auch jeder Leser auskennt [*], kann man es übersetzen mit ((Title|Titel)). Ich würde das aber eher als seltene Ausnahme ansehen.

* Auf http://support.mozilla.com/de/kb/Server+nicht+gefunden habe ich die 2 Artikel-Verknüpfungen übersetzt, obwohl die verknüpften Artikel selbst noch nicht übersetzt sind. Die Verknüpfungstitel unterscheiden sich dort nämlich von den Artikeltiteln auf im englischen Original. Außerdem sind die Verknüpfungstitel eine Art Beschreibung und nicht nur einfach eine interne URL.
Benutzeravatar
Lendo
Moderator
 
Beiträge: 1540
Registriert: Fr, 07. Okt 2005 16:07
Wohnort:

Beitragvon deschen2 » Sa, 18. Okt 2008 20:33

Mir ist gerade noch etwas unangenehm aufgefallen:

Überschriften kann man ja mit mit "!" markieren, wobei "!" für die Ober-Überschrift und "!!" für Unter-Überschriften steht.

Warum werden aber !-Überschriften KLEINER angezeigt als !!-Überschriften? Das ist unlogisch und wirkt verwirrend, wenn man sich nach einer optischen Gliederung richten will.

MfG...
Benutzeravatar
deschen2
Senior-Mitglied
 
Beiträge: 4101
Registriert: Mo, 27. Mär 2006 16:24
Wohnort: Mainz

Beitragvon Lendo » Sa, 18. Okt 2008 21:03

deschen2 hat geschrieben:Warum werden aber !-Überschriften KLEINER angezeigt als !!-Überschriften? Das ist unlogisch und wirkt verwirrend, wenn man sich nach einer optischen Gliederung richten will.
Naja, Überschriften erster Ordnung scheinen wirklich kleiner zu sein. Dafür haben sie mehr Abstand nach oben und oberhalb einen Trennstrich zum vorigen Abschnitt. Überschriften 2. Ordnung sind unterstrichen und haben weniger Abstand nach oben und keinen Trennstrich oberhalb.

Aber - das ist nicht (nur) unser Problem. Wenn du es melden willst, mach das bitte im Forum http://support.mozilla.com/tiki-view_fo ... &forumId=3 oder direkt bei einem der Verantwortlichen und deren Blogs (z.B. Chris Ilias).
Benutzeravatar
Lendo
Moderator
 
Beiträge: 1540
Registriert: Fr, 07. Okt 2005 16:07
Wohnort:

Beitragvon deschen2 » Sa, 18. Okt 2008 21:39

Jetzt mal doof gefragt: wie kommt man von der SUMO Startseite in diese tiki-view Forum??? Dabei handelt es sich ja offensichtlich nicht um das support forum. Ich kann zwar in meinem Benutzerkonto meine gestellten Fragen sehen, aber man will ja auch mal direkt hinnavigieren!:wink:

MfG...

[Edit]: Lendo, kannst du in diesen Beitrag auch noch einen Hinweis zu bestimmten Schreibweisen hinzufügen??? Ich sehe z.B., dass boersenfeger in einem Artikel aus "Shift-Taste" (korrekt) "Shift Taste" gemacht hat. Danach hast du es wieder geändert. Vielleicht ist auch ein Extra-Thread "Rechtschreibhürden: die häufigsten Fehler" angebracht? So spart man sich vielleicht ein wenig das Hin-und Hereditieren!:wink:

MfG...
Benutzeravatar
deschen2
Senior-Mitglied
 
Beiträge: 4101
Registriert: Mo, 27. Mär 2006 16:24
Wohnort: Mainz

Beitragvon Fux » Sa, 18. Okt 2008 23:04

deschen2 hat geschrieben:"Shift-Taste" (korrekt) "Shift Taste"

Ich würde da ja doch lieber die "Umschalttaste" sehen ;)
Schönen Gruß, Fux

Bild
Bitte keine technischen Anfragen per Mail oder PN, sie werden definitiv nicht beantwortet.
Benutzeravatar
Fux
Site Admin
 
Beiträge: 1269
Registriert: Do, 01. Jul 2004 16:43
Wohnort: Freiburg

Beitragvon deschen2 » Sa, 18. Okt 2008 23:17

Mmh, ich merke grad: im Artikel selbst steht Umschalttaste. Ich glaube, das "Shift" ist nur für Mac-user sichtbar. Das war ja damals mein erster Artikel, und da wusste ich mit dem "spanfor"-zeuch noch nix anzufangen und habe daher alles, was damit zu tun hatte, so gelassen. Daher noch das eine "Shift"!

MFG...
Benutzeravatar
deschen2
Senior-Mitglied
 
Beiträge: 4101
Registriert: Mo, 27. Mär 2006 16:24
Wohnort: Mainz

Nächste

Zurück zu Mitarbeit bei Übersetzung und Support

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 0 Gäste