La storia del nuovo sito di documentazione basato su Markdown di 4D

Tradotto automaticamente da Deepl

di Arnaud Schmitt, responsabile della documentazione tecnica di 4D SAS

Come molti di voi sanno, doc.4d.com è stato a lungo gestito con un’applicazione interna di 4D. Tuttavia, la documentazione di 4D è attualmente in fase di transizione verso una nuova architettura: un sito di documentazione basato su Markdown.

Questo argomento è stato trattato qualche settimana fa durante un meetup di 4D Method, dove ho condiviso la nostra esperienza sulla creazione e la manutenzione del nuovo sito di documentazione. Potreste trovare queste informazioni utili quando navigate nel sito di documentazione di 4D o se dovete creare la vostra documentazione.

Perché un nuovo sito di documentazione?

Il precedente sito di documentazione di 4D è ancora vivo e molto utile, ma è obsoleto e tende a essere difficile da evolvere a causa del vecchio codice. Quindi quello che volevamo era

  • un nuovo design per le nuove tecnologie,
  • un modo per documentare l’API con classi, ereditarietà, gerarchia, ecc.
  • per avere un maggiore controllo su formati, stili, build, ecc.

In questo video spiego in dettaglio le ragioni di questa transizione, l’architettura generale e molto altro:

Sentitevi liberi di seguirmi sul Forum 4D se avete domande.

Che cos’è 4DMethod?

Il gruppo4DMethod è un gruppo di utenti 4D organizzato da Brent Raymond.

Il gruppo si riunisce regolarmente per creare una comunità di utenti e sviluppatori 4D, discutere di problemi tecnici con i sistemi attuali e di idee per lo sviluppo futuro, offrire soluzioni di codifica a sviluppatori nuovi ed esperti, per citarne alcuni.

Per saperne di più sul 4DMethod , cliccate qui.

Arnaud Schmitt
Dopo aver conseguito un master in Comunicazione e Marketing presso l'Università Sorbona di Parigi, Arnaud ha iniziato la sua carriera nel settore dei media come giornalista e segretario di redazione. Appassionato di informatica, all'inizio degli anni '90 è entrato a far parte della società ACI (poi diventata 4D) come redattore tecnico. Proseguendo l'avventura in 4D, Arnaud ha assunto la direzione del reparto Documentazione. Nel corso degli anni, ha supportato sia le evoluzioni del prodotto 4D che quelle degli strumenti di documentazione, da FrameMaker a Docusaurus, passando per Doc Center.