Dokumentation bitte nur an einer Stelle

  • Mit wachsender Funktionalität (was ganz toll ist) wird eine gute Dokumentation immer wichtiger. Denn was nützt dem Anwender das tollste Stück Software, wenn niemand weiß, was drin ist oder wie man es verwenden soll/muss/darf. Z.B. fange ich so langsam an den Überblick über die verschiedenen Auflösungen, Anweisungen für Mobil, Tablet und Co. zu verlieren. Mal ist ein XML Tag (bei Image), mal ein Attribute ("devices"). Jetzt wird auch zusätzlich noch der Displaytyp (retina) verwendet. Hui, wenn das nicht mal in Zukunft aus dem Ruder läuft.

    Leider ist die Doku dazu etwas verstreut. Natürlich zunächst im Hauptteil unter "Dokumentation". Für die mobiles Geräte gibt es nur Beispiele unter "iPhone/iPad" und Neuerungen werden nur im Forum beschrieben. Vor allem, ich muss zwingend alle drei Stellen verfolgen, um auf dem Laufenden zu sein -> sehr mühsam.

    Ich habe eigentlich nur eine Bitte, Klaus: bitte die Doku nur an einer Stelle. Du brauchst es nur einmal an zentraler Stelle zu schreiben und der Suchende weiß auch, wo er (sonst wäre er ja nicht suchend *smile*) suchen muss.

    Und damit verbunden eine Frage: Lassen sich nicht die Tags und die Attribute auf ein Schema reduzieren? Warum bei Image anders wie bei allen anderen Tags? Das ist im Moment die Ausnahme zu Regel. Man kommt schnell auf den Gedanken, Image über das devices Attribute genauso zu filtern wie alle anderen Tags auch und es wäre wieder einheitlich.

    Gruß
    Michael

  • Hi,

    Z.B. fange ich so langsam an den Überblick über die verschiedenen Auflösungen, Anweisungen für Mobil, Tablet und Co. zu verlieren. Mal ist ein XML Tag (bei Image), mal ein Attribute ("devices"). Jetzt wird auch zusätzlich noch der Displaytyp (retina) verwendet. Hui, wenn das nicht mal in Zukunft aus dem Ruder läuft.

    Ich verstehe was du meinst aber noch gibt es keine Empfehlung oder ähnliches bereits bestimmte Bildergrößen z.B. für iPad 3 zu verwenden, das devices "retina" soll erst einmal nur ermöglichen ein "Retina" Display generell zu erkennen.
    An den genauen Details zu sinnvollen Größen für bestimmte Geräte wie z.B. das iPad 3 arbeite ich noch, wobei ich natürlich versuchen möchte das so weit wie möglich zu automatisieren, d.h. selber in der XML per devices spezielle Bilder einzubinden sollte dann nicht notwendig sein.

    Und damit verbunden eine Frage: Lassen sich nicht die Tags und die Attribute auf ein Schema reduzieren? Warum bei Image anders wie bei allen anderen Tags? Das ist im Moment die Ausnahme zu Regel. Man kommt schnell auf den Gedanken, Image über das devices Attribute genauso zu filtern wie alle anderen Tags auch und es wäre wieder einheitlich.

    Der aktuelle Aufbau hat teilweise wie so oft historische Gründe - die <mobile> und <tablet> Elemente für kleinere Bilder kammen mit der Version 1.0.8.10, dann mit der 1.0.8.12 Version das "devices" für <plugin> und <hotspot> Element und erst seit der 1.0.8.14 Version kann die "devices" Einstellung generell für alle XML Elemente verwendet werden.

    Mittels der Verwendung von der "display.usedesktopimages" Einstellung würden sich die <image> Elemente auch genauso per devices="..." filtern lassen ohne das es notwendig wäre <mobile> und/oder <tablet> Element zu verwenden.

    Da der Viewer selbst aber abwärtskompatibles sein soll, werden diese verfügbaren Einstellungen selbst natürlich nicht entfernt, aber in zukünftigen Versionen der Tools (welche ja den XML Code erzeugen) vermutlich auch anders genutzt werden.

    Die iPhone/iPad Seite ist leider schon wieder etwas veraltetet, ich plane aber diese aber mit der 1.0.9 Version vollständig zu erneuern bzw. auch in die normale Dokumentation zu integrieren.

    Schöne Grüße,
    Klaus

  • Wenn ich noch etwas anfügen darf. Es ist sehr verwirren das die eine oder andere Beschreibung bzw. Dokumentation mal ein English und Deutsch verfügbar ist und dann eben mal nur in English... Nicht das ich dem englishen nicht mächtig wär, aber es ist wäre einfach viel besser, wenn es sowie als auch wäre oder aber eben wirklich nur in English.

Participate now!

Don’t have an account yet? Register yourself now and be a part of our community!