Dokumentationen und Styleguides

tempa wrote this 12:44:

Manche Dinge wollen und sollen in einem begleitenden Dokument zur Website mitgeliefert sein. Bislang geschah dies in einem PDF-Dokument, der pflegeanleifung.pdf (ca. 483kb) dies hat den Vorteil, dass man diese ausgedruckt neben seine Tastatur legen kann.

Jetzt habe ich einmal eine neue Dokumentenform ausprobiert: DOMslides

Mich selbst mit dem Auslieferungstermin unter Druck gesetzt entstand das Dokument gestern von ca. 20.00 Uhr bis morgens um 3.00 Uhr. Somit verzichtete ich auf einige Feinheiten und akzeptierte den einen oder anderen „Bug“.

Beim Arbeiten mit Texteditor und Browser (Schreiben im Editor, ALT+Tab, F5, Ergebnis im Browser prüfen, ALT+Tab, Schreiben im Editor) erwies sich das System der DOMSlides von Christian Heilmann als ein wenig nervig, denn mit F5 sprang der Browser natürlich auf die erste Seite mit der Aktualisierung und man musste auf sich noch zur eigentlichen Änderung durchklicken. Das „TOC“ in der rechten unteren Ecke war hier recht hilfreich. Da es relativ verlinkte Grafiken enthält, um das Dokument auf dem lokalen Rechner betrachten zu können, ist es am besten gezippt auf den Weg durch die elektronische Autobahn geschickt. Damit ist der Vorteil eines einzelnen HTML-Dokumentes, integrierte man Script und CSS in das Dokument auch schon wieder verloren. Verloren geht der History-Back-Button des Browsers, da die Seite beim Navigieren nie verlassen wird.

Vorteil auch hier, wer die Seite auf Papier möchte, kann es sich mit einem schnellen Klick auf die Druckschaltfläche ausdrucken … ich habe es noch nicht getestet und stelle nun heute morgen fest, dass ich auch nicht darauf geachtet habe, ob nach den Folien ein Seitenwechsel integriert ist und dieser Seitenwechsel sich damit an Folien orientiert … und Druckvorschau … ok … tut es nicht. Das aber ist etwas, das man in das Dokument leicht integrieren kann. Schade, dass Christian Heilmann noch nicht daran gedacht hat. Naja, beim nächsten Mal dann … dann ist auch ein Print-Stylesheet dabei.

Aus meiner Warte gesehen ist das PDF-Dokument, das Auftrag für Auftrag in CI und Screenshots, sowie kundenspezifischen Eigenheiten schnell über Suchen und ersetzen oder kurz die Grafik ersetzt, angepasst ist, die bequemere und weniger denklastige Tätigkeit. Mag aber auch sein, dass das PDF öfter ausgeliefert wurde und einen Entwicklungsprozess hinter sich hat, während ich die DOMslides zu sehr später Stunde nach einem ungewöhnlich hektischen Tag ausprobierte.

Nun wäre da noch S5 das wieder etwas heftiger in Bezug auf die Kilobytes ist, aber von den Präsentationen, die ich bislang gesehen habe und den stimmen zur Bedienung mehr bietet. Hier sollte aber erwähnt sein, dass Christian Heilmann mit gutem Grund und sehr bewußt reduzierte. Sie in seinem Blog (engl.).

Feedback wird gerne entgegengenommen, wobei Tipp- und Rechtschreibfehler nicht gemeint sind, sondern eher der Umgang und die empfundenen Unterschiede der beiden Dokumentformen. 😉

Achja, und die nummerierte Liste ist in den DOMSlides nicht möglich. Wieso das so ist, konnte ich gestern Nacht nicht mehr ermitteln. Es ist sehr seltsam.

Leave a Reply