SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

エンジニアのためのドキュメントライティング術

技術者向けドキュメント、書き方のコツは? ドキュメントを書き始める際の具体的な方法を伝授

エンジニアのためのドキュメントライティング術 第2回

  • X ポスト
  • このエントリーをはてなブックマークに追加

運用フェーズ

 ドキュメントは、リリースしたら終わりではありません。プロダクトと同様に、作って終わりではなく、ユーザーからのフィードバックを基に、運用やアップデートを続け、場合によっては廃止する必要があります。ここではフェーズ3(運用フェーズ)の取り組みを3つ紹介します。

  • 読まれているか、役立っているかをチェックする
  • ドキュメントの鮮度を確認・更新する
  • プロセスでドキュメントをメンテナンスする

読まれているか、役立っているかをチェックする

 ドキュメントが狙った通りにユーザーに使われて、効果を発揮しているかを観察・計測することが重要です。たとえば、以下の方法が考えられます。

  • 定量的な指標
    • Webドキュメントならページビューや閲覧時間
    • ユーザーサーベイを通じた満足度
    • ユーザーの離脱箇所
  • 定性的なフィードバック
    • 実際にカスタマーサクセスやユーザーと話をする
    • 「ここがわかりにくい」「手順が足りない」など具体的な声を拾う

 このような指標を通じて、「そもそも読まれていない」「読まれてはいるが、意図した行動変容を起こせていない」といった状況がわかります。その状況に応じて、ドキュメント自体を改善すべきか、場合によっては削除すべきか決断しやすくなります。

ドキュメントの鮮度を確認・更新する

 ドキュメントは一度書けば永続的に活用できるか、というとそういうわけではありません。開発が進むにつれて、仕様や機能は変化していきます。変化に追従して、ドキュメントも更新しなければ、どんどん古い情報が残されていきます。この古い情報が増えると、逆にユーザーを混乱させるリスクが高まります。

 したがって、ドキュメントがある時点でもまだ有効かどうか、プロセスに組み込んで確認していきましょう。

プロセスでドキュメントをメンテナンスする

 重要なドキュメントは、その更新を「誰が」「いつ」「どのように」やるのかを明確にしておきましょう。特にドキュメントのオーナーが定まっていないドキュメントは、更新されないまま放置される可能性が高くなります。

 具体的にはリマインド機能があるツールを使って見直しタイミングをトリガーしても良いですし、業務プロセスとしてドキュメントを見直すタイミングを用意してもよいでしょう。

次のページ
生成AIとドキュメントライティング

この記事は参考になりましたか?

  • X ポスト
  • このエントリーをはてなブックマークに追加
エンジニアのためのドキュメントライティング術連載記事一覧
この記事の著者

岩瀬 義昌(イワセ ヨシマサ)

 大手通信事業者にて、大規模IP電話システムの開発、内製、アジャイル開発、人事などの業務に従事後、現在はGenerative AI Project の Leaderを務める。『エンジニアのためのドキュメントライティング』『エレガントパズル エンジニアのマネジメントという難問にあなたはどう立ち向かうのか』『エンジニアリングが好きな私たちのためのエンジニアリングマネジャー入門』を翻訳。エンジニアに人気のポッドキ...

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

この記事は参考になりましたか?

この記事をシェア

  • X ポスト
  • このエントリーをはてなブックマークに追加
CodeZine(コードジン)
https://codezine.jp/article/detail/17977 2025/01/29 11:00

おすすめ

アクセスランキング

アクセスランキング

イベント

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー

アクセスランキング

アクセスランキング