テクニカルチュートリアル
HTTP リファレンスページをリクエストライフサイクルのレッスンに変換する
この試してみる
“利用 MDN HTTP 概要, クライアント設定からHTTPリクエストライフサイクルを回答、キャッシング、および失敗の境界線を通じて説明します。”
開発者文書を正確なビデオに変換する
アップロード API ドキュメンタリー、変動ログ、統合ノート、アーキテクチャ グラフ、および他の開発者 ドキュメンタリーは、リクエスト パス、システム 行動、バージョン 変更、およびレビュー ポイントを表示するビデオを生成します。
視覚的な順序を使用して、システムの道を説明します。
イラスト・ワークフロー · Blueprint Breakdown
Atlas Scheduler v3 建築とリリースガイド
この試してみる
“利用 @Atlas Scheduler v3 建築とリリースガイド, ソースを開発者やテクニカルコミュニケーターのための明確な図面破裂説明に変換します。”
Illustrative Workflow · コントロールルーム概要
Northstar Service Degradation Triage と Handoff Runbook について
この試してみる
“利用 @Northstar Service Degradation Triage と Handoff Runbook について, ソースを IT 作業チームのための明確なコントロールルーム概要説明に変換します。”
誰のためにあるのか
開発者関係チーム
新しい開発者の方向性を提供する説明が必要です 完全なドキュメンタリーセットをナビゲートする前に。
- デヴィルチーム
- 開発者弁護士
典型的な文書:API ドック建築図製品・エンジニアリングチーム
リリースまたは統合の変更が、システムのさまざまな部分を所有する人々の間でコミュニケーションを容易にすることを望んでいます。
- 製品管理者
- エンジニアチーム
典型的な文書:チャンゴル統合ノート
文書の準備
すでに信頼している情報源から始めましょう。
APIドック、アーキテクチャ・グラフ、Changelogs、および統合ノートなどの開発者ドキュメンタリーをビデオに変換すると、人々がフォローして再度見ることができます。
- 開発者文書
- API ドキュメンタリー
- 建築図
- チャンゴル
- 統合ノート
あなたが始める前に
- 現在の完全なソースバージョンを使用する
- 注目に値するセクション、ステップ、グラフ、または数字をマークします。
- 残すべき用語、数字、警告、または文字を特定する。
集中的な道
道を説明し、最終点の名前だけではない。
- 1
視聴者の質問名
開発者の目標、彼らが理解する必要があるシステム関係、そして現在のバージョンまたは限界が重要です。
- 2
詳細を伝える情報源をもたらす。
現在のソースを追加し、説明が保存しなければならないセクション、用語、数字、またはステップを指定します。
- 3
使用文脈の説明を再現する
APIまたは製品所有者が共有する前に、用語、サンプル行動、バージョン参照、セキュリティ感性の限界を確認してください。
役に立つ次のステップ
このタスクに合ったリソースまたはケースを使用する
ソースサポートのスクリプトを使用して、技術的なパスを表示する
技術文書
テクニカルドキュメンタリーを明確なビデオに変換する
建築ガイド、開発者ドキュメンタリー、およびIT実行書を明確な技術的な説明ビデオに変換するための実用的なガイド。
このリソースを利用する テンプレートとチェックリスト複雑なプロセス説明スクリプトテンプレート
コピー可能な60秒のスクリプトテンプレートで、プロセス、決定、グラフ、または技術的なワークフローを明確な視覚的証拠で説明します。
このリソースを利用する IT オペレーティングテンプレートIT Runbook to ビデオテンプレート
コピー可能なテンプレートで、ITのルーブブックを静かで役割特性のビデオに変換し、最初のチェック、ルート、ハンドフを明確にする。
このリソースを利用する ソースサポートケースリリースアーキテクチャのガイドを開発者上のビデオに変換する方法
アーキテクチャとリリースガイドが構成要素、リリースストリーム、および貢献の文脈を結びつける開発者ビデオになる方法を見る。
読むケースデザイン ソースサポートケースどうやって IT 事件のルーブックを静かなトライジングビデオに変換するか
IT サービス デグレーション ルーブブックを見ることは、ステータスチェック、エスカレーション 所有権、および作業チームの次の更新を示す静かな試験ビデオになります。
読むケースデザイン