4Dの新しいMarkdownベースのドキュメントサイトの裏話

Deeplからの自動翻訳

by 4D SAS 技術文書責任者 Arnaud Schmitt

多くの人が知っているように、doc.4d.comは長い間4D社内のアプリケーションを使用して管理されてきました。しかし、4Dのドキュメントは現在、新しいアーキテクチャに移行中です:Markdownベースのドキュメントサイトです。

これは、数週間前の4Dメソッドのミートアップで話題になったもので、私は新しいドキュメントサイトの作成とメンテナンスに関する私たちの経験を共有しました。この情報は、4Dドキュメントサイトを閲覧しているとき、または、あなた自身のドキュメントを作成する必要があるときに役立つかもしれません。

なぜ、新しいドキュメントサイトなのか?

以前の4D ドキュメントサイトはまだ生きていて、とても便利なのですが、時代遅れで、古いコードのため、進化させるのが難しい傾向があります。そこで、私たちが求めたのは

  • 新しい技術に対応した新しいデザイン
  • クラス、継承、階層などのAPIをドキュメント化する方法。
  • フォーマット、スタイル、ビルドなどをよりコントロールするために

このビデオでは、この移行の背景となった理由、全体的なアーキテクチャなどを詳しく説明します。

質問があれば、4Dフォーラムに気軽に参加してください。

4DMethodとは?

4DMethodグループは、Brent Raymondが主催する4Dユーザーグループです。

このグループは、4Dユーザーと開発者のためのコミュニティを提供し、現在のシステムに関する技術的な問題や将来の開発に関するアイデアを議論し、新しい開発者や経験豊富な開発者にコーディングソリューションを提供するなど、定期的なミーティングを開催しています。

4DMethodの詳細はこちら

Arnaud Schmitt
パリ・ソルボンヌ大学でコミュニケーションとマーケティングの修士号を取得後、ジャーナリストおよび編集秘書としてメディア業界でキャリアをスタートさせる。ITに情熱を傾け、90年代初頭にACI社(後の4D社)にテクニカルライターとして入社。ITに情熱を傾け、90年代前半にACI社(後の4D社)にテクニカルライターとして入社し、4D社での冒険を続けながら、ドキュメンテーション部門の責任者に就任。長年にわたり、4D製品の進化と、Doc Centerを含むFrameMakerからDocusaurusまでのドキュメントツールの進化の両方をサポートしてきた。