Blog 4 Umbraco 2.0.21 - Dokumentation
Montag, 21. Dezember 2009 von Immo WacheKategorien: Umbraco Blog deutsch Weihnachtskalender
Original von Per Ploug Hansen
Von Anfang ist es das Ziel des Weihnachtskalenders 2009 ein besseres Blog-Package für Umbraco zu schaffen. Doch das bisherige Hauptaugenmerk lag dabei vor allem auf den neuen Merkmalen. Wir haben zwar auch einiges noch verschönert und der Oberfläche den letzten Feinschliff gegeben, aber es ging vor allem darum die Merkmale zum Laufen zu bringen.
Um die ganze Sache richtig rund zu bekommen wollen wir daher die letzten Tage vor den Weihnachtsferien dazu nutzen unsere Zeit auch den restlich erforderlichen Dingen zu widmen. Wir wollen ja am Ende ein wirklich fertiges Blog-Package haben. Und dazu gehört neben all den tollen neuen Funktionen auch eine ordentliche und übersichtliche Dokumentation. Diese soll alle erforderlichen Informationen beinhalten, wie das Package installiert und konfiguriert wird und wie das Design angepasst und erweitert werden kann. Darüber hinaus soll der Benutzer bei der Installation jede erforderliche Hilfestellung bei seinen ersten Schritten mit dem Package bekommen.
Daher geht es heute um die Arbeiten rund um die Dokumentation, und wie diese zum Projekt hinzuzufügen sind.
Für Designer und Entwickler
Als erstes haben wir natürlich an die Dokumentation für die Designer und Entwickler gedacht. Immerhin haben wir die Community bereits um Mithilfe bei die Entwicklung weiterer Designs gebeten. Daher haben wir heute ein vollständiges Beispieldesign hinzugefügt, welches komplett aus Manifest, CSS-Datei, Anzeige- und Vorschaubild besteht. Es enthält damit alle Bestandteile, um es als Design auf packages.umbraco.org hochladen zu können.
Darüber hinaus haben wir statische HTML-Seiten zur Unterstützung beigefügt, sodass für den Design-Entwurf keine Website mit dem Blog 4 Umbraco Package erforderlich ist. Unter Mac OS X reicht somit z.B. textmate, um mit dem Design zu beginnen.
Schließlich haben wir auch den ersten Entwurf zum Handbuch für Designer aufgenommen. Es enthält bisher schon über 10 Seiten mit Hinweisen und Tips zur Struktur der Dokumentvorlagen, die Platzierung der HTML-Elemente und die Platzhalter für die Dokument-Inhalte in den Masterpages. Und einige weitere werden noch folgen.
Für Endanwender
Auch eine Anleitung für die Benutzung und Konfiguration ist in der Entstehung. Sie wird alle erforderlichen Informationen umfassen die der Blog-Editor kennen muss, um mit seiner Arbeit am Umbraco Blog erfolgreich beginnen zu können. Das umfasst alle Aspekte von der Installation und der Konfiguration der Funktionen bis zu den Einstellungen für das optische Erscheinungsbild. Bisher sind schon Kapitel über die Konfiguration der Blog-Pings und Akismet hinzugefügt - weitere werden folgen.