Die Flexperten Herrlich & Ramuschkat

Archiv für die Kategorie 'Dokumentation'

ColdFusion Dokumentation: Initiativen zur Verbesserung der Dokumentation

Innerhalb von nur wenigen Tagen haben sich gleich zwei Initiativen gebildet, die es sich zum Ziel gesetzt haben, die ColdFusion-Dokumentation zu verbessern. Angefangen hat Adobe, wie uns Ray Camden in seinem Blog mitteilt. Diese Initiative läuft unter der Obhut von Adobe, wird von Mitgliedern der CF-Community begleitet und lebt von den Kommentaren, die die Nutzer der Livedocs dort ggf. hinterlassen (gilt sowohl für die Doku, als auch für die Beispiele). Verbesserungsvorschläge aus den Kommentaren sollen dann in die Doku übergehen.

Die zweite Inititative zielt darauf ab, das die Nutzer der Doku (bzw. des Guides “Developing ColdFusion 9 Applications”) diese selber ändern können sollen, wie uns Mike Henke in seinem Blog mitteilt. Bei dieser Initiative sollen die Nutzer der Doku die Möglichkeit haben, über GIT direkt im Browser Fehler zu korrigieren oder die Beispiele zu verbessern.

Adobe Community Help Client

Der Adobe Community Help Client (CHC) ist eine AIR Anwendung und wird zusammen mit dem Coldfusion Builder ausgeliefert. Der CHC bietet Informationen über die Benutzung des Coldfusion Builders und über Coldfusion 9. Die Inhalte der Hilfe werden direkt aus dem Netz geladen. Es ist auch möglich, den CHC seperat herunter zu laden und zu installieren.
Mittlerweile gibt es auch eine überarbeitete Version des CHC, bei dem u.a. die Informationssuche effektiver gestaltet wurde.

Weitere Coldfusion Dokumentationsseite

Dale Fraser war so freundlich, eine weitere Coldfusion Dokumentation in’s Netz zu stellen: cfmldocs.com

Ähnlich wie bei den CFQuickDocs erhält der Benutzer eine flottere Übersicht über Tags und Funktionen von Coldfusion, das Navigieren ist nicht so schwerfällig, wie in den Adobe LiveDocs und die Hilfeseiten wirken insgesamt konsistenter.

Darüber hinaus plant Dale einige interessante Features. So soll es eine downlaodbare ZIP-Datei der Hilfe geben und einen täglichen auto-tweet über ein CF-Tag, um dem geneigten Entwickler jeden Tag ein neues CF-Tag vorzustellen.

Sowohl die Inhalte von CFQuickDocs, als auch von cfmldocs.com können als Browser Search Plugin genutzt werden.