Cs:Dobré komentáře sad změn

From OpenStreetMap Wiki
Jump to navigation Jump to search

Proč bych měl používat komentáře k sadám změn?

Existuje mnoho důvodů, proč byste měli používat komentáře k sadám změn pro popis vaší úpravy:

  • Z ohleduplnosti k ostatním maperům, protože jim to pomůže pochopit, co jste udělali a proč. Neuvedení komentáře ukazuje postoj "do toho vám nic není, co jsem tu udělal a proč" a to se nehodí v projektu, kde všichni spolupracujeme na stejné věci!
  • Pro zamezení nepochopení a pro schopnost rychle opravit chyby – pokud sada změn s komentářem "nakreslil jsem několik budov podle Bingu" smaže 50 restaurací, je okamžitě jasné, že to musela být chyba. Zatímco komentář "odstranil jsem restaurace, které jsou již zrušené, což jsem zjistil v terénu během minulého týdne" potvrzuje, že jste opravdu chtěli tyto restaurace odstranit z dobrého důvodu.
  • Pro zvýšení hodnoty vašich změn a zabránění "edit wars" vysvětlením, proč jste změnu provedli a jaké zdroje jste použili. Pokud někdo zjistí, že jste přidali budovu, která není vidět na jeho satelitních snímcích, může mít pokušení ji smazat, ale pokud do komentáře napíšete, že se jedná o nově postavenou budovu, určitě si to rozmyslí.
  • Jako pomůcka pro vás "aide memoire". Komentáře k sadě změn vám pomůžou vzpomenout si na to, co jste dělali, proč a kdy. Pamatujte, že třeba za 6 měsíců nebo za rok zjistíte, že by se vám tato informace hodila, ale teď je těžké odhadnout, proč budete potřebovat hledat tuto starou změnu.


Někteří mapeři používají komentáře k sadě změn také pro záznam toho, co ještě zatím nebylo uděláno (… ale stále je potřeba dodělat", "… ale na západ od řeky to stále chybí" a tak dále).

Existují situace, kde je jasné, o čem je sada změn – zvlášť když změny ovlivňují pouze jeden objekt – ale tyto situace jsou méně běžné než byste čekali. Pokud jste opravili překlep, komentář ke změně ve znění "opraven překlep" stále ujasňuje situaci, že to byl opravdu váš záměr a ne zase kočka hrající si na klávesnici.

Příklady

Dobrý komentář k sadě změn by měl konsistentně a plnohodnotně vysvětlovat vaši změnu. Minimálně to zahrnuje sloveso (jak jste věci změnili) a předmět (co jste změnili), ale může být rozšířeno zmíněním míst, které jste upravili a zdrojů, které jste použili. Příklady dobrých komentářů mohou vypadat takto:

  • "Přidány budovy v průmyslové zóně."
  • "Přidán chodník z Donnington Close do Roman Way na základě místní znalosti"
  • "Aktualizace dánských názvů ulic podle OSAK (AWS): Bag Hegnet"
  • "Upravena hranice parku Algonquin"
  • "Přidány venkovské cesty a cyklostezky jihovýchodně od Newport"
  • "Köln: Nicht-Kreisverkehre, 'junction=roundabout' entfernt, Vz 215 nicht vorhanden"
    • Česky: "Kolín: Není kruhový objezd, junction=roundabout odstraněno, dopravní značky typu 215 na místě nejsou"
  • "Přidáno pár přílivových zálivů na pobřeží Maranhão"
  • "Přidány domy a domovní čísla na základě fotomap Bingu a lokální znalosti. Některé jsem ale bohužel nenašel."

Některé komentáře k sadám změn jsou ale zbytečné a nepřináší žádnou z výhod, které mohou komentáře přinést. Opět, skutečné příklady:

  • "BBOX:3.23,41.96,3.23,41.96 ADD:14 UPD:0 DEL:0"
  • "151005-DE-FUe"
  • "Edit uploaded via ArcGIS Editor for OpenStreetMap feature service dec20 at 1/13/2012 9:56:00 AM"
  • "nějaké změny"
  • "oprava"
  • "rozšíření mapy"
  • "--"

Prosím, pamatujte si, že vaše komentáře ke změnám zůstanou v databázi tak dlouho, jak dlouho bude projekt existovat. Nepoužívejte je k vylívání si hněvu na software nebo na ostatní mapery, kteří vás upozornili na to, že byste mohli něco opravit nebo se zeptali na vaše zdroje.

Opatrně s přidáváním dalších změn k existujícím změnám

Snažte se zachovat sady změn rozumné velikosti, jak v počtu změn, tak v geografickému rozsahu.

Chování různých editorů:

  • iD vytváří sadu změn pro každé nahrání. → Tato sekce není relevantní pro editor iD.
  • Potlatch (verze 1 a 2) přidává automaticky nové změny k existující změně, ale napsáním "C" lze uzavřít sadu změn.
  • JOSM automaticky vytváří novou sadu změn pro každé nahrání, ale můžete to změnit nastavení maximální velikostí nahrávání.

Když nahrajete změnu a zadáte popis sady změn, některé editory (s nějakým nastavením) nemusí vždy uzavřít sadu změn a následující úpravy mohou být přidány do stejné sady změn a tím dostat stejný komentář.

Pokud jste dokončili jednu editaci a začínáte něco jiného, ujistěte se, že máte toto "něco jiného" zaznamenáno v samostatné sadě změn s vhodným komentářem.

Znovupoužívání starých komentářů

Většina editorů vám dovolí znovu použít některý starší komentář v roletě nebo automatickým předvyplněním políčka pro komentář. To někdy může dávat smysl, ale nespadněte do "pasti pohodlnosti" používání příliš obecných komentářů (např. "nějaké opravy") jenom proto, že je můžete znovu použít pro všechny vaše změny. To dělá komentář bezúčelný. Dejte si také pozor, abyste pro nové změny nepoužívali starý komentář, který neodpovídá tomu, co jste udělali.

JOSM předvyplňuje automaticky komentář s komentářem poslední sady změn (pokud je novější než 4 hodiny). To může občas vést k znovupoužití starého (a špatného) komentáře. Předvyplňování můžete úplně zakázat podle návodu.

Hashtagy

Někteří uživatelé začali používat takzvané "hashtagy" v komentářích sad změn. Tyto značky jsou většinou určeny pro stroje a ne pro lidi. Byly diskuze, jestli hashtagy patří mezi dobré komentáře ke změnám, ale nedošlo k žádným závěrům. OpenStreetMap umožňuje přidávat jiné tagy ke změnám a počítačově zpracovatelná klíčová slova by byla lépe umístěna ve zvláštní značce "keywords" nebo "hashtags". K srpnu 2017, iD editor podporuje samostatné pole "hashtags" pro nahrávání sad změn. I přesto, některé nástroje stále předvyplňují komentář ke změně s textem obsahujícím hashtagy, zatímco ostatní nástroje používají nebo na nich dokonce závisí pro analýzu/vizualizaci změn. Hashtagy jsou jednoduchá slova v rámci textu ve volné formě začínající znakem mřížka (#). Mohou být použity zvlášť, nebo v rámci textu vytvořeného člověkem jako komentář čitelný pro lidi. Dobrý komentář by měl být čitelný pro lidi, spíše než aby obsahoval pouze předvyplněný text.

Co mám dělat, pokud někdo nepoužívá dobré komentáře ke svým sadám změn?

Hezky je poproste, aby je používali!

Pokud komentujete sadu změn jiného autora, vždy buďte slušní

Ahoj $mapper

nebo

Ahoj $mapper a vítej v OpenStreetMap!

pokud jsou noví. Pokud používají krátké a neužitečné komentáře jako ".", můžete použít tento komentář v diskuzi:

Prosím, používejte komentáře, které dávají smysl – “.” nepomůže nikomu k pochopení, co děláte.

Pokud rozumí stejnému jazyku jako vy, pak samozřejmě můžete napsat komentář v daném jazyce; pokud ne, nepoužívejte automatický překlad pomocí Google/Microsoft/Deepl do jejich jazyka.

Viz také