Die Geschichte hinter der neuen Markdown-basierten Dokumentationsseite von 4D

von Arnaud Schmitt, Leiter der Technischen Dokumentation bei 4D SAS

Wie viele von Ihnen wissen, wurde doc.4d.com lange Zeit mit einer internen 4D Anwendung verwaltet. Die Dokumentation von 4D befindet sich jedoch derzeit im Übergang zu einer neuen Architektur: einer Markdown-basierten Dokumentationsseite.

Dies war das Thema eines 4D Method Meetings vor einigen Wochen, bei dem ich über unsere Erfahrungen mit der Erstellung und Pflege der neuen Dokumentationsseite berichtete. Vielleicht finden Sie diese Informationen nützlich, wenn Sie die 4D Dokumentationsseite durchstöbern, oder wenn Sie Ihre eigene Dokumentation erstellen müssen.

Warum eine neue Dokumentationsseite?

Nun, die frühere 4D Dokumentations-Website ist immer noch lebendig und sehr nützlich, aber sie ist veraltet und lässt sich aufgrund des alten Codes nur schwer weiterentwickeln. Was wir also wollten, ist:

• ein neues Design für neue Technologien,
• eine Möglichkeit zur Dokumentation der API mit Klassen, Vererbung, Hierarchie usw.
• mehr Kontrolle über Formate, Stile, Builds usw. zu haben

In diesem Video erkläre ich im Detail die Gründe für diesen Übergang, die Gesamtarchitektur und vieles mehr:

Wenn Sie Fragen haben, können Sie mich gerne im 4D Forum kontaktieren.

Was ist 4DMethod?

Die4DMethod Gruppe ist eine 4D Benutzergruppe, die von Brent Raymond organisiert wird.

Die Gruppe veranstaltet regelmäßige Treffen, um 4D Anwendern und Entwicklern eine Gemeinschaft zu bieten, technische Probleme mit aktuellen Systemen und Ideen für zukünftige Entwicklungen zu diskutieren, neuen und erfahrenen Entwicklern Programmierlösungen anzubieten, um nur einige Beispiele zu nennen.

Mehr über die 4DMethode erfahren Sie hier.