A história por detrás do novo site de documentação baseado em Markdown da 4D

Tradução automática de Deepl

por Arnaud Schmitt, Chefe da Documentação Técnica na SAS 4D

Como muitos de vós sabem, o doc.4d.com tem sido gerido há muito tempo utilizando uma aplicação 4D interna. No entanto, a documentação 4D está actualmente em transição para uma nova arquitectura: um site de documentação baseado em Markdown.

Este foi o tema há algumas semanas durante uma reunião do Método 4D, onde partilhei a nossa experiência sobre a criação e manutenção do novo site de documentação. Poderá achar esta informação útil quando estiver a navegar no site de documentação 4D, ou se precisar de criar a sua própria documentação.

Porquê um novo sítio de documentação?

Bem, o sítio de documentação 4D anterior ainda está vivo e é muito útil, mas está desactualizado e tende a ser um desafio para evoluir por causa do código antigo. Portanto, o que nós queríamos é:

  • um novo design para novas tecnologias,
  • uma forma de documentar API com classes, herança, hierarquia, etc.
  • para ter mais controlo sobre formatos, estilos, construções, etc.

Neste vídeo, explico em detalhes as razões por detrás desta transição, a arquitectura geral, e muito mais:

Sinta-se à vontade para se juntar a mim no Fórum 4D se tiver alguma questão.

O que é o 4DMethod?

O grupo4DMethod é um Grupo de Utilizadores 4D organizado por Brent Raymond.

O grupo organiza regularmente reuniões para fornecer uma comunidade tanto para utilizadores como para programadores 4D, discutir questões técnicas com sistemas actuais e ideias para desenvolvimento futuro, oferecer soluções de codificação a programadores novos e experientes, para citar alguns.

Saiba mais sobre o 4DMethod aqui.

Arnaud Schmitt
Depois de obter um mestrado em Comunicação e Marketing na Universidade Paris Sorbonne, Arnaud começou a sua carreira na indústria dos media como jornalista e secretário editorial. Apaixonado pelas TI, entrou para a empresa ACI (que mais tarde se tornou 4D) no início dos anos 90 como escritor técnico. Dando continuidade à aventura 4D, Arnaud assumiu desde então a chefia do departamento de Documentação. Ao longo dos anos, apoiou tanto a evolução do produto 4D como as dos instrumentos de documentação, desde FrameMaker até Docusaurus, incluindo Doc Center.