Frame Vertex Lab

サービス 02 / ドキュメントレビュー

ドキュメントが、
実態に追いついていますか。

フレームワークは成長するのに、ドキュメントはそのままになっていることがあります。現状を外側から丁寧に読み解き、何を優先して更新すべきかを書面でまとめます。

フレームワークドキュメントレビューのイメージ

このサービスが届けること

ドキュメントの現在地を、
はっきりさせる。

このエンゲージメントが終わると、手元に観察記録と優先度付きの更新リストが残ります。何を直すべきか、どの順番で取り組むと効率的かが、チームで議論できる形になります。

ドキュメントを全部書き直す前に、まず何が足りていて何が古くなっているかを把握する。このサービスは、そのための入口として設計されています。

— 成果物

観察記録ドキュメント

既存ドキュメントと実際のコンポーネントを照合した結果を書面でまとめます。不足・齟齬・表現の不一致を確認できます。

— 成果物

更新提案リスト(優先度付き)

対応が必要な箇所を優先度順に整理した一覧をお渡しします。着手順の検討がしやすくなります。

— 成果物

90分のウォークスルーセッション

観察内容を直接説明し、解釈や対応の進め方についてチームと話し合います。

よくある背景

ドキュメントは書いた。
でも、もう実態と合っていない。

デザインフレームワークのドキュメントは、プロダクトの変化に合わせて更新し続けることが難しい資産です。最初は丁寧に書かれていても、コンポーネントの追加・変更・廃止が重なるうちに、実際の状態とずれてきます。

そのずれに気づいていても、「全部確認する時間がない」「どこから手をつければよいかわからない」という状況になりやすいです。このサービスは、そういった状態に外側からの整理を持ち込みます。

ドキュメントに書いていないコンポーネントがある

実装側では使われているのに、ドキュメントへの追記が追いついていない状態。

ドキュメントと実装が食い違っている

仕様が変わったのにドキュメントが更新されておらず、参照しても古い情報が出てくる。

どこを直すべきかの判断が難しい

問題がある箇所はなんとなくわかるが、全体を把握した上での優先度付けができていない。

このサービスのアプローチ

照合・記録・整理の
三つで進めます。

ドキュメントと実態の照合

既存のドキュメントを通読し、現在のコンポーネントの実際の状態と突き合わせます。記述の有無、内容の一致、表現の一貫性を確認します。

観察内容の記録

確認した内容を、項目ごとに整理して書面にまとめます。何が問題で、どの程度の影響があるかも記述します。

優先度付きの更新提案

対応が必要な箇所を優先度順に整理します。何を先に直すと効果的かについての視点も添えます。

作業の流れ

ご共有いただいた後は、
こちらで丁寧に読み進めます。

フェーズ 01

資料の受け取りと確認範囲の合意

現在のドキュメントとコンポーネントの参照先をご共有いただきます。どの範囲を今回のレビュー対象とするかを確認します。

フェーズ 02

照合と観察の記録

ドキュメントを一通り確認し、コンポーネントの実態と照合します。不足・齟齬・表現の揺れを記録します。

フェーズ 03

観察記録と更新提案の整理

観察した内容をまとめ、優先度付きの更新提案リストを作ります。必要に応じて確認の連絡を挟みます。

セッション

90分のウォークスルー

成果物をお渡しし、チームと内容を確認します。解釈の共有と、今後の対応の進め方について話し合います。

費用と内容

更新作業を始める前の、
状況把握への投資として。

このエンゲージメントは、ドキュメント更新の着手前に行う現状把握のために設計されています。何がどの程度ずれているかを把握してから更新作業に入ることで、作業の無駄が減ります。

ドキュメントの量や複雑さによって作業範囲が変わる場合があります。ご相談の段階でスコープを確認し、費用をお伝えします。

料金目安

¥38,000

標準スコープの場合

ドキュメントと実態の照合・確認

観察記録ドキュメント

優先度付き更新提案リスト

90分のウォークスルーセッション

作業期間:数週間程度

アプローチの根拠

外側からの読み解きが、
内側では見えにくいものを照らします。

— 観点 01

慣れた目には見えにくい齟齬がある

日常的にフレームワークを使っているチームにとって、ドキュメントのずれは当たり前になってしまい気づきにくくなります。外部からの一読が新しい視点をもたらします。

— 観点 02

優先度を決めることが更新を始める第一歩

「どこかがずれている」はわかっても、「何から直すか」が決まらないと作業は始まりません。優先度付きのリストが着手の糸口になります。

— 観点 03

セッションで解釈の共有がしやすくなる

書面だけでは読み取りにくい部分も、ウォークスルーセッションで直接確認できます。チームの解釈が揃うと、その後の対応が進めやすくなります。

進め方の目安

90分

ウォークスルーセッションの所要時間

2点

主要成果物(観察記録・更新提案リスト)

数週間

標準的な作業期間の目安

安心して始めるために

レビューの内容は、
チームの判断に委ねます。

提供するのは観察と提案です。何をどの順番で更新するかは、チームが決めることです。レビュー結果を受け取った後の進め方に義務はありません。

このサービスが自分たちの状況に合うかどうか、ご相談の段階で確認できます。ドキュメントの量や現在の状態をお聞きし、対応できる範囲かどうかを正直にお伝えします。

提案はあくまで提案です

更新提案リストは、チームで検討するための出発点です。すべてを採用する義務はありません。

セッションで直接確認できます

書面の内容について疑問があれば、ウォークスルーセッションで一緒に確認できます。

事前相談に義務はありません

ご相談は、状況と合致するかを確認するための場です。その後の依頼は、納得してからで構いません。

始め方

ドキュメントの現状を、
一度話してみませんか。

01

フォームから連絡

ドキュメントの現状と気になっていることをお書きください。

02

スコープの確認

返信の中でドキュメントの範囲と費用を確認します。

03

資料の共有と作業開始

ドキュメントとコンポーネントの参照先をご共有いただき、照合を始めます。

04

成果物引き渡しとセッション

観察記録と更新提案をお渡しし、90分のウォークスルーを行います。

お問い合わせ

ドキュメントの現状について、
聞かせてください。

どのくらいずれているのか、どこが特に気になっているかをお書きください。状況に合わせてお応えします。

お問い合わせフォームへ

他のサービス

状況に合わせて選べる、他のサービス。

サービス 01

コンポーネントライブラリ初期整備

既存コンポーネントの棚卸しと分類体系の提案。命名規則と文書化の出発点を整えます。2〜3週間のエンゲージメント。

¥24,000

詳しく見る

サービス 03

インターフェース標準整備エンゲージメント

複数プロダクトにまたがる命名規則・コントリビューション・アクセシビリティ基準を文書化。組織のデザインリーダーシップとのセッションで締めくくります。

¥43,500

詳しく見る