DE:Key:comment

Ein comment (Kommentar) wird meistens verwendet, wenn Changesets=Änderungssätze beschrieben werden und wurde während API 0.6 eingeführt. Es wird als ein Weg für Mapper genutzt, um zu beschreiben, was und von mehr Interesse, warum sie solche Änderungen gemacht haben. Zum Beispiel wenn ein Knoten, der mit highway=bus_stop getaggt ist, verschoben wird, könnte das Changeset kommentiert werden mit "Bushaltestelle verschoben nach kürzlich durchgeführten Straßenarbeiten" oder "Bushaltestelle verschoben, war an falscher Stelle". Das kann dann helfen, anderen Mappern zu erklären, warum spezielle Änderungen gemacht wurden.

Der Kommentar-Tag wird an verschiedenen Stellen auf der Website gezeigt, insbesondere in der Versionsgeschichte und anderen Ansichten, die Changeset=Änderungssatz beinhalten. Ein Changeset-Kommentar ist eine Botschaft an Eure Mapper-Kollegen (m/w), in der Ihr ihnen sagt, was Ihr getan habt und warum. Deshalb zeugt eine aussagekräftige Botschaft für Achtung vor Euren Mapper-Kollegen (m/w).

Sich die Zeit nicht zu nehmen oder nichtssagende Kommentare hinzuzufügen wird von manchen als unhöflich oder gar als respektlos betrachtet. Auf der anderen Seite werden viele Changeset-Kommentare möglicherweise nicht einmal gelesen und manche betrachten es als unnütze Zeit, etwas zu tun, das nur wenige wenn überhaupt jemand jemals lesen wird und würden die Zeit eher nutzen, um die Daten der Karte zu verbessern. DE:Good changeset comments gibt Empfehlungen zu guten Kommentaren.

Die Unterscheidung zwischen Notiz and Kommentar ist, daß eine Notiz üblicherweise bei Knoten/Wegen/Relationen verwendet wird, um Dinge der realen Welt zu beschreiben wie "Die Bushaltestelle ist tatsächlich hier aber das Haltestellenzeichen wurde im September 2009 umgerissen", wohingegen ein Kommentar bei Changesets genutzt wird.

Hilfestellung für Entwickler

Insbesondere mit Hinblick auf Changeset:

• Kommentar-Tags sollten nicht automatisch erzeugt werden. Wenn ein daten-verbrauchendes Projekt automatisierte Daten anfordert, kann es diese selbst berechnen.
• Kommentar-Tags sind nicht verpflichtend - z. B. vielleicht eignet sich der Workflow eines Editors/Eingabeprogramms nicht dafür, Kommentare hinzuzufügen (vgl. Potlatch live mode). Dennoch sind aussagekräftige Changeset-Kommentare sehr nützlich. Deshalb ist es eine gute Idee für Eingabe-Werkzeuge, es Mappern einfach zu machen, sie hinzuzufügen. Wenn eure Software die Kommentare zur Pflicht macht, könntest du herausfinden, dass manche Mapper in einer negativen Weise reagieren und „Müll“-Kommentare eingeben.
• Kommentar-Tags sollten im Editors/Eingabeprogramm zur Verfügung stehen, wenn der User sie verwenden will.

Siehe auch

• DE:Annotations — Übersicht: Stellt anderen Mappern weitergehende Informationen über einzelne Tag-Werte bereit.
• note=* — um Notizen für Dich selber oder Deine Mapper-Kollegen(m/w) hinzuzufügen
• description=* — Beschreibender Text, der ggf. auch gerendert wird/für den Endnutzer sichtbar sein wird