ライブでインタラクティブなリンクを共有することは、共同作業の最も迅速な方法ですが、頻繁に図をコードリポジトリ、本番用ウィキ、エンジニアリング用スライド、または社内メッセージングチャネルなどの外部環境に直接埋め込む必要があります。VPasCodeは、テキスト駆動のスクリプトをすばやくクリーンで本番用の画像ファイルに変換できる、組み込みのアセットエクスポートルーチンを提供しています。
これらのオプションは、ワークスペースの上部コントロールツールバーから直接アクセスでき、ワンクリックでベクターグラフィックスと高解像度の静的画像の両方を生成できます。
ベクタードキュメントのエクスポート(PDF)
このPDFとしてエクスポートルーチンは、公式な文書作成、コンプライアンスアーカイブ、印刷用レポートに最適です。PDFはベクターフォーマットであるため、すべての線、形状、テキストレイヤーがピクセルではなく、独立した幾何学的オブジェクトとして保持されます。
PDFを選択すると、いくつかの重要な利点が得られます:
-
企業およびコンプライアンス標準:汎用的で編集不可のフォーマットが必要な公式仕様書、セキュリティ監査レポート、契約添付ファイルに図を簡単に統合できます。
-
印刷用解像度:大規模で詳細なシステムアーキテクチャが、印刷時や高DPIのドキュメントリーダーで表示された際にも、鋭いクリアさを保証します。
-
汎用ドキュメント互換性:公式な複数ページレポートに挿入するのに最適です。PDFは、あらゆるブラウザやオペレーティングシステムで一貫したフォントとレイアウトの正確性を保証します。
クリアなベクターグラフィックスのエクスポート(SVG)
このSVG(スケーラブルベクターグラフィックス)としてエクスポートルーチンは、技術文書作成に強く推奨される選択です。標準画像とは異なり、SVGはXMLベースのテキストファイルであり、ブラウザやドキュメントビューアに、線、形状、テキストブロックを動的に描画する方法を正確に指示します。
SVGを選択すると、いくつかの重要なワークフロー上の利点が得られます:
- 無限のスケーラビリティ:SVGはベクターベースであるため、図がぼやけたり、ピクセル化されたり、歪んだりすることはありません。同僚が小さなラップトップディスプレイでも、巨大な4Kモニターでも、ソフトウェアアーキテクチャのレイアウトを表示していても、すべてのノードとラベルが完璧に鮮明なままです。
- 軽量なサイズ:SVGファイルはラスターファイルと比べて非常に小さなファイルサイズであるため、ウェブドキュメントハブやオンラインウィキページ内で迅速に読み込むのに最適です。
- Markdown埋め込みに最適:ダウンロードした`.svg`ファイルをプロジェクトのGitリポジトリに直接保存し、標準のMarkdown画像構文を使って、
README.mdまたはドキュメントファイルにクリーンに埋め込むことができます。
高解像度の静的画像の生成(PNG)
The PNG(ポータブル・ネットワーク・グラフィックス)としてエクスポートこのルーチンは、現在市場に出回っているほぼすべてのソフトウェアで認識されるユニバーサルなスナップショット形式を提供します。このルーチンを実行すると、VPasCodeは即座にレイアウトをクリーンで独立したラスタ画像ファイルにパッケージ化します。
PNGエクスポートは、製品チーム間での高速なコミュニケーションに最適です:
- スムーズなチャットへの投稿:バグ修正、ユーザー・フローの変更、データパイプラインの調整について、エンジニアリングチームと迅速に合意したい場合、PNGスナップショットをエクスポートして、SlackやMicrosoft Teams、Discordのチャットにそのまま貼り付けることで、即座にフィードバックを得られます。
- プレゼンテーション対応:PNGファイルは、ベクターレイアウトの互換性を気にせずに、スライドデッキ(PowerPointやKeynoteなど)やプロダクトマネジメントダッシュボード(JiraやTrelloなど)に直接ドラッグアンドドロップできます。
- 最適化されたフレーミング:エンジンは、PNGのバウンディングボックスをレンダリングされた図の正確な境界に自動的に調整するため、不恰好な余白や空白のパディングに対処する必要がありません。
どのエクスポート形式を選べばよいでしょうか?
チームのドキュメントパイプラインの効率を最大化するため、以下のクイックリファレンスガイドに従って、タスクに適したアセット形式を選択してください:
| 対象環境 | 推奨形式 | 主な利点 |
|---|---|---|
| Gitリポジトリ、GitHub/GitLabのMarkdown、技術用Wiki | SVG | ズームしてもテキストが無限に鮮明なまま。Gitのファイル追跡にネイティブに対応。 |
| Slack、Microsoft Teams、即時チャットレビュー | PNG | チャットウィンドウ内に即座に拡張可能なプレビューとしてレンダリングされます。 |
| 経営者向けプレゼンテーション、PDFレポート、プロダクト概要 | PNG / SVG | PNGは普遍的に動作する。SVGは、印刷やドキュメントのリサイズ時に完全なクリアさを保証する。 |
プラットフォームのコア機能、ワークフロー、アセット管理コントロールを習得したので、特定の構文ハンドブックに進む準備ができています。次のセクションに進んで、PlantUML Playbook!