OpenSeaMap-dev:Wiki-Guidelines: Unterschied zwischen den Versionen

Aus OpenSeaMap-dev
Wechseln zu:Navigation, Suche
(Hilfe und Manuals)
 
Zeile 2: Zeile 2:
 
* Hilfe und Manuals
 
* Hilfe und Manuals
 
* dev-Wiki
 
* dev-Wiki
 +
  
 
__TOC__
 
__TOC__
Zeile 52: Zeile 53:
 
Hilfeseiten und Manuals werden in Deutsch geschrieben und auf Englisch übersetzt oder umgekehrt.
 
Hilfeseiten und Manuals werden in Deutsch geschrieben und auf Englisch übersetzt oder umgekehrt.
  
Deutsche Artikel haben das Prefix "de:"
+
Deutsche Artikel haben das Prefix "De:"
<br> Englische Artikel haben das Prefix "en:".
+
<br> Englische Artikel haben das Prefix "En:".
 +
 
 +
Titel sind in Landessprache formuliert.
  
 
Im Kopf der beiden Artikel (vor dem Inhaltsverzeichnis und vor dem ersten Text) steht dieser Code:
 
Im Kopf der beiden Artikel (vor dem Inhaltsverzeichnis und vor dem ersten Text) steht dieser Code:
Zeile 61: Zeile 64:
 
!style="background:#E3E3E3;" | [[h:De:<seitentitel>|Deutsch]]
 
!style="background:#E3E3E3;" | [[h:De:<seitentitel>|Deutsch]]
 
!style="background:#E3E3E3;" | [[h:En:<page_title>|English]]
 
!style="background:#E3E3E3;" | [[h:En:<page_title>|English]]
!style="background:#E3E3E3;" | [[h:Fr:<page_title>|Français]]
+
!style="background:#E3E3E3;" | [[h:Fr:<title_du_page>|Français]]
 
!style="background:#E3E3E3; width:100%;" |  
 
!style="background:#E3E3E3; width:100%;" |  
 
|}
 
|}
 
</pre>
 
</pre>
  
Siehe auch: [[Website:translation]]
+
Siehe auch: [[OpenSeaMap-dev:Q:Translation needed|Translation needed]]
  
 
== dev-Wiki ==
 
== dev-Wiki ==

Aktuelle Version vom 31. Januar 2021, 17:44 Uhr

Das OpenSeaMap-Wiki besteht aus zwei getrennten Teilen mit verscheidenen Zielen und Inhalten:

  • Hilfe und Manuals
  • dev-Wiki


Grundlagen

Wir verteilen Information gezielt "top-down" auf die geeigneten Plattformen:
Siehe: Documentation_and_Communication

Wikipedia
alles was für die breite Öffentichkeit interessant ist
beispielsweise GPS, ECDIS
Voraussetzung: es muss "enzyklopädisch" formuliert sein
OSM-Wiki
alles was für OSMer interessant ist:
alles zum Thema "tagging" (Attribute, Schlüssel, Werte, Anleitungen und Erklärungen)
Commons
alle Bilder die wir veröffentlichen wollen
Bilder aus Commons stehen jedermann zur Verfügung und können z.B. in jedem Wiki eingebunden werden
OpenSeaMap-Wiki
Speicherplatz für Hilfe-Texte und HowTo's die auf der Web-Vollbildkarte oder in unseren Programmen verwendet werden.
OpenSeaMap-dev-Wiki
alles was die Entwickler intern besprechen
Planung, Forschung, Entwicklung, Doku, etc

Hilfe und Manuals

Anders als andere Wikis dient das OpenSeaMap-Wiki ausschliesslich als
Speicherplatz für Hilfe-Texte, Manuals und HowTo's.

Diese Seiten sind Master-Seiten und werden vom zuständigen Entwicklerteam geschrieben.
Sie beschreiben immer den aktuellsten Stand. Idealerweise mit Erscheinungsdatum, Freigabe und Gültigkeit.
Abgeleitete Werke (z.B. gedruckte Bedienungsanleitungen) beziehen sich immer auf diese Masterseite.
Sie dienen den Benutzern als Nachschlagewerk.

Sie sollen folgende Merkmale erfüllen:

  • immer aktuell und auf dem letzten Stand
  • für Benutzer geschrieben: verständlich, übersichtlich, bebildert, nachvollziehbar, umfassend

Diese Seiten liegen im Namensraum "h:".

Die hier abgelegten Dateien werden vorwiegend von externen Stellen aus verlinkt, beispielsweise von Websiten, Foren, anderen Wikis (Wikipedia, OSM-Wiki, Fach-Wiki, etc), aber auch von gedruckten Informationen (Flyer, Presse, Benutzerhandbuch, etc). Und natürich - wo sinnvoll - auch untereinander hier im Wiki.

Beispiele:

h:De:Marker in URL - Anleitung zum Setzen eines Markers in der Karte, den man dann als Link in eine Website einbinden oder per Mail verschicken kann
h:De:Mess-Strategie - Anleitung zum Messen von Wassertiefen

Sprachen

Hilfeseiten und Manuals werden in Deutsch geschrieben und auf Englisch übersetzt oder umgekehrt.

Deutsche Artikel haben das Prefix "De:"
Englische Artikel haben das Prefix "En:".

Titel sind in Landessprache formuliert.

Im Kopf der beiden Artikel (vor dem Inhaltsverzeichnis und vor dem ersten Text) steht dieser Code:

{|border="0" cellpadding="6" cellspacing="0" width="100%"
!style="background:#E3E3E3;" | Sprachen:
!style="background:#E3E3E3;" | [[h:De:<seitentitel>|Deutsch]]
!style="background:#E3E3E3;" | [[h:En:<page_title>|English]]
!style="background:#E3E3E3;" | [[h:Fr:<title_du_page>|Français]]
!style="background:#E3E3E3; width:100%;" | 
|}

Siehe auch: Translation needed

dev-Wiki

Das dev-Wiki ist ein internes Wiki für die Entwickler.
Es dient der Planung und Dokumentation unserer Entwicklungsarbeit.

Darin werden Projekte dokumentiert, Vereinbarungen festgehalten, Abläufe beschrieben, Ergebnisse aus Diskussionen festgehalten (beispielsweise aus der dev-Mailingliste oder dem Forum). Auch HowTos für Entwickler gehören hierher. Es dient auch der Planung und Diskussion. Das dev-Wiki ist also ein ganz normales Wiki, aber mit eingeschränktem Teilnehmerkreis. Um den internen Charakter zu wahren wird das dev-Wiki nicht extern verlinkt. Es ist aber öffentlich zugänglich. Schreibrecht gibt es für angemeldete Entwickler.