社内技術ドキュメントで「このページはなに?」を書くすすめ
こんにちは!電通デジタル開発部エンジニアのリチャードです。この記事では、エンジニアが社内技術ドキュメントを書く際、「このページはなに?」というページごとの目的を記載することの有用性を紹介します。
ここでいうページとはWebページのことで、相互にリンクし合うページの集まりとして構成する社内技術ドキュメントを本記事では対象としています。本記事で対象としないものの例は、1つの巨大なPDFファイルで構成された技術ドキュメントなどです。
ただページに情報を残すのではなく、「このペー