Kurviger.de | Application | Blog | Frequently Asked Questions (FAQ) | Legal Notice | Privacy Policy

Documentation, Quick Info

DE: Vermisse Kurzübersichten (Beispiele):

  • Vergleich Features von Web, App Free, App Pro
  • Erklärung der Benutzeroberfläche mit Begriffsdefinitionen der einzelnen Elemente
  • Angaben zu Anmeldung und aktiver Mitarbeit (z.B. Oberfläche und Elemente der Editierwerkzeuge) im Forum und beim Doku-Wiki
    In diesem Zusammenhang: Sind im Wiki tabellarische Listen möglich?Muss beim arbeiten im Wiki ein bestimmter Workflow (deutscher und englischer Artikel) beachtet werden?
    Für Eure Ratschläge zur Mitarbeit schon jetzt herzlichen Dank. Vielleicht können dann ein paar Lücken geschlossen werden.

EN: Missing Quick Info (Examples):

  • Comparison Features from Web, App Free, App Pro
  • Illustration of surface of web and app and Definition and declaration of the particular elements
  • Information to Registration and active working (e.g. surface and elements of editing Tools) in Forum and wiki
    In this context: Is it possible to use tables in the wiki? Is a specific workflow to consider working in the wiki (german and english articel)?
    For Your Advices for Collaboration Thanks in Advance. Perhaps some gaps may be closed.
    (Due to my bad english knowledge there may be missunderstandings, if the advices are only in english)

Unser Ansatz ist im Allgemeinen, dass die Webseite und Free Version mehr oder weniger die gleichen Funktionalitäten aufweisen. Die Pro Version bietet nochmal eine ordentliche Schippe mehr Funktionen. Die Hauptfunktionen werden z.B. hier erwähnt.

Das ist eine gute Idee. Man muss aber bedenken, dass die Webseite und Apps stetig leicht angepasst werden. So eine Dokumentation müsste also auch stetig angepasst werden.

Wir setzen hier jeweils Standardtools ein, die auch wieder eine eigene Dokumentation haben.

Das Wiki verwendet Dokuwiki und das Forum verwendet Discourse.

Ja das geht :slight_smile:.

Ja, einen neuen Artikel anzulegen ist nicht ganz einfach. Das übernehme ich gern für dich. Es empfiehlt sich zuerst den Englischen Artikel zu schreiben. Du kannst den Artikel aber auch erstmal nur auf Deutsch schreiben, eventuell wird er später dann auch noch auf Englisch übersetzt. Falls du einen bestehenden Artikel anpassen möchtest, dann am besten vorher mal hier im Forum die Änderungen diskutieren.


Our general approach is that the website and free version of the app contain more or less the same features, while the pro version adds additional features.

We do mention the main additional features of the pro version in the app overview here.

That’s a nice idea :slight_smile:. One issue with this is, that the website and app is constantly changing. It usually only changes in small ways, but it adds up, such a documentation would have to be updated frequently.

For the forum and wiki we use default tools, with their own documentation, we won’t be able to write a documentation for these tools as well.

The wiki uses Dokuwiki the forum uses Discourse.

Yes, tables are possible :slight_smile:.

Yes, it’s highly recommended to write the English article first and to stick with the existing namespaces. It’s usually easiest, if I set up the pages for you, so you can focus on writing. If you’d like to change existing pages, it’s probably easiest to first discuss the changes here in the forum. If you struggle with English, you could write an article only in German and someone else could consider translating it.

Diesmal nur in deutsch. Nach langer Vorarbeit habe ich mein Konzept für eine QuickInfo erheblich überarbeitet. (ein Zwischenergebnis des alten Konzepts (in Excel erstellt) seit Version 1.2 konnte ich bei der IMOT im Frühjahr 2019 Robin zeigen (auf Basis Kurviger Pro Version 1.6). Dort zeigte sich jedoch schon, dass das damalige Konzept zu pflegeintensiv ist). Robin verwies auch auf die Kurviger Dokumentation im DokuWiki. Der Pflegebedarf von Version zu Version ist inzwischen auch überschaubar. Den jetzigen Entwurf (erstellt als *.doc-Datei bzw. *.pdf auf Basis Kurviger Pro Version 1.9 und Web) in deutsch möchte ich gerne zur Diskussion stellen. Viele Texte liegen auch in englisch vor, müssen aber noch von *.xls in entsprechende Form *.doc und *.pdf gebracht werden.

Wieso QuickInfo?
Das kennenlernen von Kurviger macht nach Einträgen im Google Play Store und im Forum einigen Nutzern Probleme. Diese Einträge werfen ein schlechtes Bild auf Kurviger, was jedoch Web-Seite und App nicht verdienen.
Dies eigentlich nur, weil die Nutzer oft nicht bereit sind, sich in die Kurviger Dokumentation und im Forum einzulesen (dies fordert wirklich viel Zeit). Unabhängig von der Form von Doku und Forum HIER EIN DICKES DANKE AN DIE ENTWICKLER VON KURVIGER UND EINIGE FORUMSTEILNEHMER, DIE IHRE ZEIT UND IHR WISSEN BEREITWILLIG ZUR VERFÜGUNG STELLEN !!! Den Nutzern fehlt teilweise das Wissen über Begriffe und Zusammenhänge bezüglich Routenerstellung und Navigation. Verweise auf andere Beiträge zu diesen Themen hilft bei diesen Nutzern häufig nicht weiter, da sie (wegen Überforderung?) in eine Blockade-Haltung gehen.
Wenn man viel Zeit zur Verfügung hat, bietet die Kurviger Dokumentation und das Forum und die enthaltenen Verlinkungen sehr viel Information. Problem ist jedoch die erforderliche Zeit.
Routenberechnung und Navigation ist ein umfangreiches Thema. Viele Nutzer sind außerdem keine Softwarespezialisten und tun sich aus diesem Grund schon schwer mit anspruchsvollen Apps und Dokumentationen in Wiki-Form (schau mal hier, schau mal da, schau mal dort). Ja, es gibt tatsächlich Leute, die damit Probleme haben. Kann mancher PC-, Smartphone- und Software-Mensch kaum glauben.
Es fehlt eine Übersicht, die auf die Begriffe der Kurviger-relevanten Themen eingeht und diese in knapper Form erläutert. Dadurch kann man bei Rückfragen auch mit einheitlichen Begriffen arbeiten. In der Übersicht sollte auch die Benutzeroberfläche und ihre Elemente erklärt werden.
Die Erstellung so einer Übersicht versuchte ich in Form einer QuickInfo. Anhand der QuickInfo sollte ein Bedienen der App durchaus möglich sein.
Für tiefergehende Information und die Lösung von Problemen bei Sprachausgabe, Geräteverbindung, Übertragen von Routen auf andere Geräte usw. steht dann immer noch die Kurviger Dokumentation und das Forum zur Verfügung. Evtl. macht. ein Verweis auf die QuickInfo aber auch im Forum die Beantwortung von Fragen einfacher.

Entwurf:
quickinfo001.pdf (3.0 MB)

Die Texte habe ich nach bestem Wissen erstellt. Fehler kann ich leider nicht ausschließen. Teilweise finden sich Abhandlungen in der QuickInfo und der Dokumentation in ähnlicher Form. Dies aus Gründen der kompakten und zusammenhängenden Information. Außerdem versuchte ich die bisherigen Begriffe weiterzuverwenden. Teilweise ist die Gliederung nicht korrekt. Dennoch stelle ich die QuickInfo zur Diskussion. Die Kapitel zu den Aktionen und Bedienung von App und Web-Seite fehlen im Entwurf. Dennoch liegt schon viel Info zu Plattformen, Begriffen und Benutzeroberflächen vor. Inhaltsübersicht und Links für schnelles vorankommen in der Datei fehlen noch.
Habe mich mit der Forum- und Wiki-Software beschäftigt. Leider komme ich nicht mit ihnen zurecht, um Texte formatiert, mit Bildern und teilweise tabellarisch darzustellen. Da ist einfach zu viel “Neuland” für mich dabei. Dennoch wollte ich meinen Entwurf nicht im Sande verlaufen lassen und weiter verschleppen.

Deshalb zunächst folgende Fragen
Seht ihr Bedarf an einer QuickInfo zu Kurviger?
Ist die Wahl der Kapitel brauchbar?
Ist der Aufbau der einzelnen Kapitel brauchbar, bzw. wo sind Änderungen erwünscht?
Ist der Inhalt der Kapitel brauchbar, bzw. wo sind Änderungen erwünscht?

Konstruktive Kritik ist erwünscht.

Bevor weiter Arbeit und Zeit in die QuickInfo investiert wird, sollte der Bedarf an dieser hier im Forum erkennbar sein. Zu gegebener Zeit wäre dann auch “Nachhilfe” bzw. Unterstützung bei der Forum- und Wiki-Software erwünscht. Für Überarbeitung und Korrektur der QuickInfo liegt eine *.doc-Datei vor, bzw. es sollte ein Weg für Korrekturvorschläge gefunden werden.

4 Likes

Pinging @boldtrn, das musst du mal angucken Robin

Wow @WalterG, erstmal vielen vielen Dank für die wirklich beeindruckende Leistung.

Ich sehe definitiv den Bedarf für eine bessere und ausführlichere Dokumentation für Kurviger. Gerade eine bessere Einführung oder QuickInfo könnte vielen Nutzern enorm helfen.

Da hast du mit unglaublich viel Arbeit echt etwas beeindruckendes vollbracht.

Ich persönlich würde es wichtig finden diese Infos in die Kurviger Dokumentation zu bringen. Dort gibt es ja bereits einen “Getting Started Guide”. Hier könnte man z.B. viele der Infos zu App unterbringen. Einige andere Themen würde z.b. gut in die FAQ passen. Man könnte z.B. auch ein “Getting Started” für die Webseite schreiben.

Zwei verschiedene Systeme (pdf und Wiki) führen aus meiner Sicht zu vielen potentiellen Problemen. Eventuell wäre auch ein ganz anderes System ideal?

Ich kann dir da natürlich sehr gern helfen. Wir können gern mal einen Termin ausmachen dann können wir uns die Wiki Software zusammen anschauen bzw. ich kann dir z.B. eine Seitenstruktur bereitstellen, etc.

Ich finde den Inhalt sehr gut und finde auch die Beschreibungen der Funktionen wirklich klasse.

Für eine "Quick"Info finde ich 23 Seiten schon sehr ausführlich. Aus meiner Sicht geht das aktuell schon in Richtung vollwertige Dokumentation. Auf der anderen Seite ist das Thema doch recht komplex und man benötigt einfach viele Infos wenn man wirklich verstehen möchte was passiert und was verschiedene Menüpunkte bedeuten.

Ich bin mal gespannt wie das andere Nutzer so sehen?

@WalterG impressive work! :slightly_smiling_face:

Danke für die Antwort.

Da sind wir somit einer Meinung:slightly_smiling_face:

Das mit dem unterbringen sehe ich noch etwas kritisch. Das mit den 2 Systemen sehe ich auch etwas problematisch. Aber ein ganz anderes Sytem muss auch gut überlegt sein und geht vermutlich nicht so ohne weiteres. PDF war für mich momentan der einzige Weg, meinen Entwurf zur Diskussion zu stellen, da ich mit Discourse und DokuWiki noch nicht zurechtkomme.

Auf dieses Angebot komme ich gerne zurück, wenn es zur Umsetzung des Projekts kommt.

Sehe ich auch so. Falls das Projekt weiterläuft, steht es bei mir unter dem Motto “Kurviger Know how (gewusst wie): Kennenlernen von Kurviger”
Auf Grund der Likes habe ich die Quelle der obigen Datei schon umbenannt und mit Inhaltsverzeichnis versehen, manche Texte überarbeitet und zugefügt, manche Bilder hinzugefügt, ein weiteres Kapitel (Kurviger und *.gpx-Dateien) ohne Ausarbeitung als Gedankenstütze hinzugefügt. Um den Thread nicht unnötig aufzufüllen, lade ich die Datei jetzt nicht hoch. Falls gewünscht, kann ich die Datei hochladen. Falls gewünscht kann man dann demnächst einen Weg zur Verbesserung des Inhalts finden.

Bin gespannt, wie sich die Dokumentation weiterentwickelt.

Sorry devemux not to write in english. Due to my english knowledge it’s to hard to me to discuss this project in this phase in english. Perhaps the discussion in german with some interested members of the comunity leads to a result. And I think boldtrn will contact you for making proposals and so on. When the concept is fixed and the texts are wanted, then most of the text I will deliver not only in german but in english too. I hope that’s Ok for you.

Also erst einmal: ich habe ganz großen Respekt vor der vielen Arbeit, die in dieser “Quickinfo” steckt! :+1:t3:

Ich hoffe, ich darf trotzdem ehrlich sein und sagen: ich bin hier wirklich ein wenig hin und her gerissen. :flushed:

Zuerst dachte ich: Ok, das soll dem Neuling helfen, die Applikation schnell zu verstehend und damit auch rasch in die Lage versetzt werden, Kurviger effektiv einzusetzen.

Leider muss ich aber sagen (ich meine das wirklich nicht böse, glaube aber, dass ehrliches Feedback hilft): das Dokument ist für meinen Geschmack viel zu überladen. Das wirkt möglicherweise eher abschreckend als hilfreich. Meiner Meinung nach stehen ganz viele Sachen drin, die entweder selbstverständlich sind (z.B. Erklärung bestimmter GUI-Elemente), oder irgendwie überflüssig (z.B. empfohlene Displaygrößen bei den Geräten), oder nur Zusammenhänge andeuten, aber nicht zuende führen (z.B. warum genau denn das .kurviger-Format empfohlen wird, wenn man offline ist).

Meiner Meinung nach wird es eigentlich erst ab Seite 14 wirklich interessant und relevant für Anfänger. Aber auch hier fände ich einen Ansatz in der Art “best practices” oder “how to” hilfreicher. Also einer Anleitung, in der eher steht “wie löse ich welche Anwendungs-Szenarien”.

Und vor allem: es existieren ja bereits die Dokus der Kurviger-Autoren. Wo genau sind die “Quickinfos” denn jetzt einzusortieren? Als Ergänzung der bestehenden Doku? Als alternative “Parallel-Doku”?

Meiner Meinung nach wäre es zielführender die Energie in Abstimmung mit den Autoren Robin und devemux86 so zu investieren, dass etwas “aus einem Guss” dabei herauskommt. So wirkt es am Ende auf manchen potentiellen Anwender eher wie ein “Sammelsurium” an Infos.

Was mir gefallen würde: den Inhalte dieser Doku nehmen, mit ein paar Aspekten der bereits bestehenden Doku zusammenlegen, nochmal mit klarem Fokus auf das Wesentliche abstimmen und dann direkt sowohl in die Webseite, als auch die App integrieren als jederzeit abrufbare Schnell- (!) Hilfe (“wie mache ich was”).

Heutzutage liest doch sowieso nur noch eine Minderheits umfangreiche Dokus. Stattdessen erwarten die Leute direkte Hilfe zu konkreten Funktionen. Und zwar “am Ort des Geschehens” (gerne auch als automatisch ablaufende Einführung bei der ersten Verwendung einer App).

Besser wäre es also z.B. jeden Menüpunkt mit einem “HowTo”-Button zu versehen, mit dem kurz (!) erklärt wird, was hier gemacht und werden kann, zusammen mit ein paar Tipps zum Einsatz (z.B. Hintergrundwissen, Fallstricke, Best Practices). Direkte Kontexthilfe ist wahrscheinlich besser als jegliche “Quickinfo”.

Es tut mir wirklch leid, dass ich das so sagen muss. Ich sehe durchaus, wie viel Arbeit hier drin steckt. Aber das ist nunmal meine Meinung zu dem Thema. :fearful:

1 Like

Du müsstest eigentlich deinen vorherigen Text anpassen können und dort auch neue Dateien hochladen können?

Absolut, vorallem das Wiki kann eigentlich bisher alles und meistert die Anforderungen sehr gut. Also falls man wechselt, dann muss das gut überlegt sein.

Ich finde sowas auch immer Klasse, aber das ist wirklich viel Arbeit, Schwer über verschiedene Systeme und Sprachen hinzubekommen, man kann nur schwer in die Tiefe gehen, und man kann nicht so einfach darauf verlinken. Zum Beispiel bei Fragen kann man gut auf die Kurviger Doku verlinken.

Jeder ist da ja auch etwas anders und jeder ist ein anderer Lerntyp. Mir ist z.B. auch der How-To Stil bzw. der FAQ Stil der Kurviger Dokumentation lieber, deswegen ist die Doku auch in dem Stil, aber das bedeutet ja nicht, dass eine ausführliche Dokumentation, bzw. Handbuch nicht auch eine Daseinsberechtigung hat.

Die Displaygröße war mir auch ein Dorn im Auge :wink:

Nach mehreren Jahren Support für Kurviger weiß ich, dass nicht alles für jeden Selbstverständlich ist :slight_smile:. Die Frage ist natürlich, wie detailliert muss man das dokumentieren.

Ich würde es sehr begrüßen, wenn wir die QuickInfo in die Kurviger Dokumentation einfließen lassen können. Dort lassen sich die einzelnen Themen dann auch gut auf eigene Seiten verteilen. So könnte man z.B. ein Glossar bzw. Begriffserklärung aufsetzen, eine eigene Seite für die Erklärung der GUI und Buttons, etc. Dann kann jeder die Themen lesen die für einen gerade relevant sind.

1 Like

Sorry, dass ich mich so lange nicht gemeldet habe. Bin zur Zeit beruflich genügend ausgelastet.
Deshalb nur kurze Statements zu wenigen Punkten.

So sehe ich das auch. Absolut kein Bedarf, große Änderungen softwareseitig vorzunehmen. Die PDF-Datei war nur ein Mittel zum Zweck, um evtl. mögliche Ansätze für eine erweiterte Dokumentation zur Diskussion zu stellen. Inzwischen gefällt mir der erste Ansatz “QuickInfo” auch nicht mehr. Da gefällt mir der obige Vorschlag von Robin schon besser.

Hallo Mario, klar darfst du ehrlich sein und deine Meinung mitteilen. Ich erwarte nichts anderes, deshalb bat ich ja um konstruktive Kritik. Deine Anmerkungen führten bei mir zu weiterem Nachdenken zur Dokumentation. Um eine Dokumentation zu erstellen bzw. zu ergänzen, muss man sich Gedanken machen, was man in der Doku unterbringen will. Auch die Textentwürfe müssen irgendwann mal festgehalten werden. Eine vielen Nutzern gerecht werdende Doku bekommt man schließlich durch Diskussion des Konzepts und der Texte.
Dieser Diskussion stelle ich mich durch die Bereitstellung der PDF-Datei. Obige Zitate z.B. von dir und Robin zeigen mir, dass man gemeinsam durchaus zu einer Weiterentwicklung der Doku kommen kann.
Auch eine Abstimmung mit den Entwicklern von Kurviger finde ich sehr Zielführend. Auch die Idee “aus einem Guss” gefällt mir.

Aus Zeitgründen kann ich momentan eure Anmerkungen nicht weiter kommentieren bzw. diskutieren. Habe mich entschieden, meine Textsammlung zu ergänzen und zu überarbeiten und zu gegebener Zeit den Entwicklern und der Community zur Diskussion zur Verfügung zu stellen, falls erwünscht.

Ende September, Anfang Oktober dürfte mein beruflicher Zeitdruck weg sein, dann kann auch ein Termin mit Robin wahrgenommen werden, um mich in die Forum- und Doku-Software einzuarbeiten. Dann kann vermutlich auch auf das Verwenden einer PDF-Datei verzichtet werden. Robin kann mir per email mitteilen, wie wir den Termin und Ort zu einem Treffen absprechen können.

Da die jetzige Doku bisher als ausreichend erachtet wurde, muss eine Überarbeitung bzw. Ergänzung oder wie man es immer nennen mag nicht unter Zeitdruck durchgezogen werden. Deshalb sollte man den “Ball flach halten” und nichts erzwingen.

Falls gewünscht, stehe ich gerne für das Projekt “Kurviger-Doku” zur Verfügung.

2 Likes

Vielen Dank für die Rückmeldung, das klingt doch alles schon mal sehr gut.

Melde dich wenns dir passt, dann machen wir was aus.