Views

Difference between revisions of "Golden Rules for Creating an Article in this Wiki"

The Wiki of Unify contains information on clients and devices, communications systems and unified communications. - Unify GmbH & Co. KG is a Trademark Licensee of Siemens AG.

Jump to: navigation, search
Line 11: Line 11:
 
# Try to grab the reader's attention by writing an '''introductory paragraph''' at the start of the article. This should be a keyword in bold print and should include at least one return link.
 
# Try to grab the reader's attention by writing an '''introductory paragraph''' at the start of the article. This should be a keyword in bold print and should include at least one return link.
 
# If external content that appeared previously in other media or documents is to be included in the article, make sure that it is released and suitable for this purpose. Only include content that you '''yourself understand''' and reformulate it if necessary to suit the article.
 
# If external content that appeared previously in other media or documents is to be included in the article, make sure that it is released and suitable for this purpose. Only include content that you '''yourself understand''' and reformulate it if necessary to suit the article.
# Achten Sie auf eine sinnvolle Artikel-'''Strukturierung''' durch Überschriften, Absätze, Listen und Tabellen. Sehr viel ununterbrochener Text macht diesen schlecht lesbar und schwer verständlich.  
+
# Give your article a meaningful '''structure''' by using headings, paragraphs, lists and tables. A long passage of continuous text is difficult to read and understand.  
# Verwenden Sie einen '''Link''' mit vom Linkziel abweichenden Linktext nur wenn unbedingt erforderlich, da der Leser hierbei in die Irre geführt werden kann. Vermeiden Sie auch Linkziele innerhalb von Artikeln, d. h. eine Verlinkung auf Artikel-Zwischenüberschriften.
+
# Only use '''links''' with a link text that differs from the link destination where absolutely necessary as this may lead the reader astray. You should also avoid link destinations within articles, i.e. linking to article subheadings.
# Erstellen Sie kein '''Dokument''' (e.g. PDF), um dieses dann im Wiki zum Download anzubieten, da dessen Textinhalt nicht durchsucht werden kann und nicht versioniert wird. Erstellen Sie stattdessen den Inhalt des Dokumentes direkt im Wiki.
+
# Do not create a '''document''' (e.g. PDF) in order to then offer it for downloading in the Wiki as the text it contains cannot be searched and will not be versioned. Instead create the document content directly in the Wiki.
# Verwenden Sie großformatige '''Grafiken''' in Artikeln immer mit einer Vorschauansicht. Der Leser kann dann selbst entscheiden, ob er sich die Vollformat-Grafik ansieht. Versuchen Sie auch, Grafiken mit viel Textinhalt zu vermeiden. Extrahieren Sie stattdessen die Textinhalte und verwenden Sie diese als Bildbeschreibung.
+
# Always use thumbnails when using large-format '''graphics''' in articles. The reader can then decide for themselves whether they want to view the graphic in full-screen format. You should also avoid graphics containing copious amounts of text where possible. Instead extract the text and use it as a Extrahieren Sie stattdessen die Textinhalte und verwenden Sie diese als Bildbeschreibung.
 
# Gewöhnen Sie sich einen guten Mittelweg beim '''Sichern''' einer Seitenänderung an. Jeder Klick auf ''Save page'' generiert eine weitere Version in der Historie eines Artikels. Wenn Sie sehr häufig sichern, bläht dies die Versionierung unnötig auf; zu seltenes Sichern birgt die Gefahr des unvorhergesehenen Datenverlustes.
 
# Gewöhnen Sie sich einen guten Mittelweg beim '''Sichern''' einer Seitenänderung an. Jeder Klick auf ''Save page'' generiert eine weitere Version in der Historie eines Artikels. Wenn Sie sehr häufig sichern, bläht dies die Versionierung unnötig auf; zu seltenes Sichern birgt die Gefahr des unvorhergesehenen Datenverlustes.

Revision as of 20:29, 4 November 2006

The following comment should be fixed | Show fixme list

Artikel mit move auf den englischen Artikel-Namen für „Wiki:Goldene Regeln für das Erstellen eines Artikels in diesem Wiki“ verschieben/umbenennen. --Horemu 19:35, 26 October 2006 (CEST)

hinterkopf.png

Observe the following golden rules, which should always be in the back of your mind when creating or editing a Wiki article.

  1. Start by performing a search in this Wiki for keywords from the planned article. If an article already exists on the topic in question, extend the existing article rather than creating a new one.
  2. If you think a new article makes sense, you must create it by adding a link in an existing article. Add further links to this article later if possible.
  3. Give the article a suitable name. This should be as short as possible, but as long as necessary. An English article should have an English name, a German article a German name. Make sure that you use the same spelling for recurring terms. Do not use any unnecessary abbreviations or colloquial expressions.
  4. Try to grab the reader's attention by writing an introductory paragraph at the start of the article. This should be a keyword in bold print and should include at least one return link.
  5. If external content that appeared previously in other media or documents is to be included in the article, make sure that it is released and suitable for this purpose. Only include content that you yourself understand and reformulate it if necessary to suit the article.
  6. Give your article a meaningful structure by using headings, paragraphs, lists and tables. A long passage of continuous text is difficult to read and understand.
  7. Only use links with a link text that differs from the link destination where absolutely necessary as this may lead the reader astray. You should also avoid link destinations within articles, i.e. linking to article subheadings.
  8. Do not create a document (e.g. PDF) in order to then offer it for downloading in the Wiki as the text it contains cannot be searched and will not be versioned. Instead create the document content directly in the Wiki.
  9. Always use thumbnails when using large-format graphics in articles. The reader can then decide for themselves whether they want to view the graphic in full-screen format. You should also avoid graphics containing copious amounts of text where possible. Instead extract the text and use it as a Extrahieren Sie stattdessen die Textinhalte und verwenden Sie diese als Bildbeschreibung.
  10. Gewöhnen Sie sich einen guten Mittelweg beim Sichern einer Seitenänderung an. Jeder Klick auf Save page generiert eine weitere Version in der Historie eines Artikels. Wenn Sie sehr häufig sichern, bläht dies die Versionierung unnötig auf; zu seltenes Sichern birgt die Gefahr des unvorhergesehenen Datenverlustes.