L’histoire du nouveau site de documentation de 4D basé sur le format Markdown

Traduit automatiquement de Deepl

par Arnaud Schmitt, responsable de la documentation technique chez 4D SAS

Comme beaucoup d’entre vous le savent, doc.4d.com est géré depuis longtemps par une application interne à 4D. Cependant, la documentation de 4D est actuellement en transition vers une nouvelle architecture : un site de documentation basé sur Markdown.

C’était le sujet il y a quelques semaines lors d’un meetup de la méthode 4D, où j’ai partagé notre expérience sur la création et la maintenance du nouveau site de documentation. Vous trouverez peut-être ces informations utiles lorsque vous naviguerez sur le site de documentation 4D, ou si vous devez créer votre propre documentation.

Pourquoi un nouveau site de documentation ?

Eh bien, l’ancien site de documentation 4D est toujours en vie et très utile, mais il est dépassé et tend à être difficile à faire évoluer à cause de l’ancien code. Ce que nous voulions donc, c’est

  • un nouveau design pour les nouvelles technologies,
  • une façon de documenter l’API avec les classes, l’héritage, la hiérarchie, etc.
  • pour avoir plus de contrôle sur les formats, les styles, les builds, etc.

Dans cette vidéo, j’explique en détail les raisons de cette transition, l’architecture globale, et bien plus encore :

N’hésitez pas à me rejoindre sur le forum 4D si vous avez des questions.

Qu’est-ce que 4DMethod ?

Le groupe4DMethod est un groupe d’utilisateurs 4D organisé par Brent Raymond.

Le groupe organise des réunions régulières pour offrir une communauté aux utilisateurs et aux développeurs de 4D, discuter des problèmes techniques des systèmes actuels et des idées de développement futur, offrir des solutions de codage aux développeurs nouveaux et expérimentés, pour n’en citer que quelques-unes.

Pour en savoir plus sur la méthode 4DM , cliquez ici.

Arnaud Schmitt
Après avoir obtenu une maîtrise en communication et marketing à l'université de Paris Sorbonne, Arnaud a commencé sa carrière dans le secteur des médias en tant que journaliste et secrétaire de rédaction.Passionné d'informatique, il a rejoint la société ACI (devenue 4D) au début des années 90 en tant que rédacteur technique. Poursuivant l'aventure 4D, Arnaud a depuis pris la tête du département Documentation. Au fil des années, il a accompagné tant les évolutions du produit 4D que celles des outils de documentation, de FrameMaker à Docusaurus, en passant par Doc Center.