本記事は MariaDB Corporation より寄稿された記事となります
はじめに
MariaDB Corporation は2019年6月に MariaDB Enterprise Server をリリース致しました。
MariaDB Enterprise Server はエンタープライズ向けにビルドされた MariaDB Server であり、エンタープライズ向け機能,エンタープライズに適したライフサイクル,デフォルト設定がエンタープライズ向けに最適化されています。
MariaDB Enterprise Server のリリースと同時に MariaDB Enterprise Documentation 公開いたしました。
今回は Enterprise Documentation に関して解説いたします。
MariaDB Enterprise Documentation 概要
- 大規模運用,コンプライアンス要件,コスト/時間の制約等の要件に対応しています。
- MariaDB Platform を統合的に利用することを前提としています。例えば,レプリケーション環境に関するドキュメントでは,自動フェールオーバーのために MariaDB MaxScale についても解説しています。
- リファレンスコンテンツが含まれていますが,導入コンテンツとユーザビリティコンテンツも含まれており,MariaDB Platform のベストプラクティスと典型的ユースケースを理解するのに役立ちます。
- ユーザーがDB管理者であることを前提としていますが,開発者/ オペレーター / ITマネージャー / 監査人 / 情報セキュリティ専門家でもある場合があります。これらの関係者間での共通理解,共同作業を可能にします。
- ドキュメントはデプロイとオペレーションだけでなく,ベンダー選定とアプリケーション設計にも利用されることを理解しています。
MariaDB Enterprise Documentation の実装
- MariaDB Corporation 全体での経験を共有するため,ドキュメントシステム設計に50人以上の社員が関与しました。社内の知見を共有することにより,開発者 / DBA / オペレーター / ITプロフェッショナルのニーズを満たすことができます。
- MariaDB 製品開発チームと協力し,リファレンスドキュメントへの新しいアプローチを試みています。
- 100 以上の軽量プロトタイプを具体化することで作成され,広範なユーザーテストが行われています。ドキュメントチームはUXプロフェッショナル、CX(カスタマーエクスペリエンス)プロフェッショナル,テクニカルライター,ITプロフェッショナルから構成されています。
- “Docs as Code” もしくは “Docs like Code“ を実践します。Git, CI/CD, リーン-カンバン-カイゼン(改善)により,複数のチームとジャストインタイム(JIT)でデプロイできます。
- ドキュメント作成にオープンソースソフトウェア(OSS)を幅広く活用しています。
- 以下のような項目に焦点を当てています:
- スマートフォンや w3m / links / lynx ブラウザでも適切にレンダリング可能なデザイン。
- 明確に定義され実装された階層アーキテクチャ。
- 検索機能は,次のようなSQL演算子にもマッチします:OR && AND ||
- デプロイメント,監査機能,バックアップなどのEnterprise Serverの主要な機能に重点を置いています。