リモートのエンジニアリングチーム向けの無料ドキュメントツール

Trupeer AIは、身を乗り出して隣の人に聞けないリモートのエンジニアリングチーム向けのウォークスルー（手順）ドキュメント作成ツールです。シニアエンジニアが説明を1回だけ記録します（デプロイのパイプラインが実際にどう動くのか、なぜこのサービスはそのやり方でリトライを扱うのか、コードベースの厄介な部分が何をしていて、なぜ厄介なのか）。そしてTrupeer AIが、同じ作業で動画と書面のエンジニアリングドキュメントの両方を生成します。別のタイムゾーン、別のオフィスで働く他のエンジニアは、非同期で視聴・閲覧します。分散したエンジニアリングチームがREADMEsの欠落で困るというより、READMEの背後にある説明が欠けていることで困るのです。その説明はシニアエンジニアが午後をかけて書く必要があり、誰もそのための余力を持っていません。

• シニアエンジニアがウォークスルーを記録。動画と書面のエンジニアリングドキュメントが同時に届きます。

• 非同期・複数タイムゾーンのワークフローに最適化。すでに分散エンジニアリングチームが日常的に行っている形です。

• 米国、インド、ヨーロッパ、LATAMにまたがるエンジニアリングチーム向けに、65+言語へドキュメントを翻訳。

• チームの既存のWiki、コードリポジトリ、APIドキュメントのそばに配置。置き換えはしません。

• 変更されたステップを再記録して更新。アーキテクチャ解説が古くなってズレません。

Trupeer AIがエンジニアリングチームに提供するもの

シニアエンジニアが画面録画を開きます。プロダクションサービスのデプロイ、ステージング環境のデバッグ、あるいは2024年にチームが採用したメッセージキューの設計判断の説明などを、順を追って解説します。Trupeer AIがポストプロダクションを担当します。無駄な言葉は削除されます。ズーム効果で、次のエンジニアが見てほしいターミナルコマンド、IDEの領域、ダッシュボードが強調表示されます。同じ場所に、下書きの動画と下書きの書面エンジニアリングドキュメントが、スクリーンショットと番号付きステップをインラインで添えて表示されます。

出力はMP4動画とPDFまたはWordドキュメントで納品されます。ドキュメントは、Wikiで読む人やNotion／Confluenceに貼り付ける人が読むものです。動画は、ヘルプセンターで視聴する人、Linearのチケットに埋め込む人、またはShared Pageリンクで共有する人が見るものです。どちらも同じ録画から作られ、2度目の作業は不要です。ブランドキットがエンジニアリングチーム固有のイントロ／アウトロスライドを適用し、カスタム用語集が、AIが本来正しく綴れない可能性のある社内サービス名、インフラ構成要素名、略語を適切に扱います。

エンジニアリングドキュメント作成ツールの仕組み（3ステップ）

3つのステップで全体の流れをカバーします。まず、シニアエンジニアが頭の中で既にやっていることを記録し、次にAIが2つの形式を生成し、最後に、タイムゾーンに関係なくチーム全員が見つけられるリンクで共有します。

ステップ1：説明を記録

ブラウザ上で、エンジニアリングチームのIDEで、またはターミナル越しにscreen recordingを開始します。シニアエンジニアは、新入社員との1対1と同じように、作業内容を話しながら進めます。アーキテクチャ解説やデプロイのウォークスルーなら、録画は通常5〜10分で十分です。AIは記録された内容をもとに処理するため、シニアエンジニアは下書きを書いたりスライドを準備したりする必要がありません。

ステップ2：AIが動画と書面のエンジニアリングドキュメントを生成

「えっと…」のような無駄な言葉や「そのファイルを探してみます」のような場面は削除されます。ズーム効果で、重要な画面の部分（ファイルパス、ターミナル出力、PRレビューでの差分）が強調表示されます。下書きの動画と下書きの書面エンジニアリングドキュメントが、エディタ上で同時に表示されます。カスタム用語集が、社内サービス名やコンポーネントの略語を、書き起こしで誤って転記される前に拾い上げます。

ステップ3：ブランド適用、翻訳、共有

brand kitを適用して、エンジニアリング内部のドキュメントがチームのライブラリ全体で一貫した見た目になるようにします。Translateで、チームが実際に使っている言語へ翻訳します。メキシコシティオフィス向けにスペイン語、バンガロールチーム向けにヒンディー語、サンパウロ向けにポルトガル語です。Wikiに置かれているShared Pageリンク経由で共有するか、チームのSlackスレッドに直接貼り付けます。エンジニアは、フローを中断せずにそこから見つけられます。

このエンジニアリングドキュメント作成ツールを開くのは誰か

このツールを開くのは、通常はスタッフエンジニア、エンジニアリングマネージャー、またはリモートファースト／ハイブリッドのエンジニアリング組織にいるテックリードです。少なくとも2つのタイムゾーンにまたがるメンバーがいる環境で使われます。新入社員が入ってREADMEだけでは足りないとき、チームが記録しておく価値のある非自明なアーキテクチャ判断を行ったとき、あるいはオンコールのランブックが、コマンドを列挙するだけではなく3amに何をすべきかを実際に説明する必要があるときに開きます。すべての主要な設計判断に日常的に使うチームもあれば、解説が必要な「説明不足のギャップ」が見えてきたときだけ手に取るチームもあります。

同じワークフローが職種をまたいで登場します。DevOpsやSREのリードは、インシデントの振り返りやインフラのウォークスルーを記録し、より広いエンジニアリング組織に共有します。エンジニアリングマネージャーは、新入社員向けのオンボーディングウォークスルーを記録して、毎週DMで同じ質問が繰り返されないようにします。テックリードは、将来のエンジニアが「なぜこのシステムはこの形なのか」を理解できるように、アーキテクチャの判断を記録します。エンジニアリング部門の責任者は、チーム横断のロールアウト（新しい社内プラットフォーム、サービス移行、デプロイプロセスの変更）を記録します。これらは本来、50人規模の全体会議が必要になるような内容ですが、誰も参加したくない会議になりがちです。

このツールが扱うエンジニアリングのコンテンツ種別

最も頻出するコンテンツ種別は、アーキテクチャ／設計のウォークスルー（なぜこのシステムはこの見た目なのか）、デプロイ／インフラのランブック（プロダクションへの出し方、ロールバックの方法）、オンボーディングウォークスルー（コードベースの案内、ローカル開発のセットアップ、最初のPRウォークスルー）、インシデントの振り返り／ポストモーテム（何が起きたか、何を学んだか、何を変えるか）、コードレビューの解説（非自明なPRの「なぜ」）です。Trupeer AIは、同じ「録画→ドキュメント」フローでこれらすべてを処理します。形式も調整されます。ランブックはスクリーンショット付きの番号付きステップを求め、アーキテクチャ解説は書面の要約付きの動画を求め、オンボーディングツアーは両方を求めます。

より広くエンジニアリングドキュメントのために、Trupeer AIは、テキストのみのWikiツールが空けてしまう「解説レイヤー」を埋めます。ソフトウェアエンジニアリングのドキュメントは通常、3つのレイヤーに分かれます。コード生成のリファレンスドキュメント（Sphinx、javadoc、OpenAPI）、チームWikiのコンテンツ（Confluence、Notion、Slab）、そして人が記録したウォークスルーです。多くのエンジニアリングチームでは、1つ目のレイヤーは自動で作られるので存在し、2つ目のレイヤーは誰かが書くためにお金をもらっているので存在します。しかし3つ目のレイヤー（ソフトウェアエンジニアリングにおけるシステムドキュメント、エンジニアリングプロジェクトのドキュメント、ソフトウェアエンジニアリングにおける社内ドキュメント）は、常に遅れがちです。Trupeer AIは、その3つ目のレイヤーを作ることを十分に速くし、シニアエンジニアが会議の合間の金曜の午後に対応できるようにします。

Wiki、コードドキュメントツール、APIドキュメントジェネレーターの隣でTrupeerが担う位置づけ

Trupeer AIは、チームのWikiを置き換えません。Confluence、Notion、Slab、GitBook、そして社内チームWikiは、それぞれが担っている役割をそのまま続けます。Trupeer AIは、録画された解説コンテンツを生成し、それらのWikiにShared Pageとして埋め込まれる形で提供します。チームがすでに書いている記事と並んで表示されます。

またTrupeer AIは、APIドキュメントジェネレーターも置き換えません。Swagger、Stoplight、Redoc、Postman、そして自動生成されるOpenAPIリファレンスは、エンドポイント単位のリファレンスドキュメントを引き続き担当します。Trupeer AIがいるのは別のレイヤーです。APIがどのように設計されたのか、実際にどう統合するのか、そしてリファレンスドキュメントでは表に出てこない「落とし穴」は何か、という人によるウォークスルーです。エンジニアリングチームのドキュメントライブラリは通常、自動生成のリファレンスと、人が記録した解説の両方を求めます。Trupeer AIはそのうち2つ目だけを扱います。1つ目はそのまま存在し続けます。同じ考え方は、Doxygen、javadoc、インラインコメントシステムのようなコードレベルのツールにも当てはまります。Trupeer AIはそれらと競合するのではなく、補完します。エンジニアリングドキュメント管理、そしてより広いテクニカルドキュメントの文脈では、つまりチームは、既に持っているものを壊さずに解説レイヤーを追加できるということです。

グローバルに分散したエンジニアリングチーム向けの更新と翻訳

エンジニアリングドキュメントは、非エンジニアのチームが想像するよりも早く劣化します。基盤となるシステムが毎週変わるからです。デプロイパイプラインの変更で前四半期のランブックが壊れる、アーキテクチャのリファクタリングで設計ドキュメントが誤解を招く、サービス名の変更でオンボーディングウォークスルーが分かりにくくなる。多くのチームは、ドキュメントが静かにズレていくことを許し、誰かが今は古くなったドキュメントに当たるたびにSlackで質問に答えることで対処しています。Trupeer AIは、変更された部分だけを再記録することで更新します。AIはその部分だけを再処理し、動画と書面のエンジニアリングドキュメントの両方をその場で更新。次にWikiを見るエンジニアは、最新バージョンを目にします。

グローバルに分散したエンジニアリングチームにとって、翻訳はスタンドアップで誰も口にしない摩擦を減らします。同じアーキテクチャ解説が、同じソース録画から、同じ週に、バンガロールチームにはヒンディー語で、ベルリンチームにはドイツ語で、サンパウロチームにはポルトガル語で届きます。翻訳は、動画の音声（ボイスオーバー）と書面のエンジニアリングドキュメントの両方に適用され、ブランドキット、用語集、画面上のテキストもそのまま引き継がれます。このエンジニアリングチーム向けドキュメント作成ワークフローを、Trupeer AI SOP builderと組み合わせることで、エンジニア向けのウォークスルーと、エンジニアリングチームが組織の他の部門へ引き渡すクロスファンクショナルな標準業務手順（SOP）の両方をカバーできます。