はじめに ドキュメント作成でいつもたくさんレビュー指摘をもらう人のための記事です。 この記事は 私自身が1年目で作成した成果物に対していただいた指摘内容 レビュー実施する前に確認しておけば良かったと思ったこと をもとに以下の確認観点を挙げました。 参考までに私がこれまで作成したドキュメントの多くは以下のようなものでした。 Excel ある程度フォーマットが決まっている リリース作業の手順書 ただし、上記に関わらずできるだけドキュメントを作成する上での汎用的な自己レビュー観点を挙げられるように努めました。 私個人の備忘も兼ねています。 読者としては社会人1年目など、ドキュメント作成に不慣れな方を想定しています。 ドキュメント作成玄人には当たり前のことかもしれません。 目次 ドキュメント作成前に ドキュメントの目的は何？ ドキュメントの読者はどんな人？ どんな順番で記述する？ ドキュメントの作

こんにちはmatinanaです。 融資型クラウドファウンディングのサービス開発を行っています。 今日は、来年3人目のエンジニア1をチームに迎えるにあたり準備しているドキュメントの話をします！ この記事はCAMPFIRE Advent Calendar 2021の13日目の記事です。 本記事の目的 この記事では、小さな開発チームである自分たちが用意している（or 用意しようと思っている）開発関連のドキュメントを共有することで、 同じような他の小さなチームの方にとって 明日から開発チームに入るドキドキのエンジニアにとって 「こういう情報があれば・分かれば」不安なく開発進められそうだな！という指針の一つになればと思っています😊 また、ドキュメントを準備している自分たちにとっても、「なんでこのドキュメントって必要なんだっけ？」という問いへの整理の意味も込めています。 目次 1. オンボーディング

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? 営業一課で使っている PHPアプリを保守してくれないかな？ ○○さんが１人で作ってメンテしてたやつなんだけど 皆さんは上司からこんな仕事を振られたことはないでしょうか？私は過去に何度か経験した1のですが、こういった仕事はなぜか： 正確な仕様を知っている人はいない（知ってた人は辞めた） テスト計画書・デプロイ手順書・仕様書といったドキュメントは無い ソースコードはもちろんスパゲッティ でも、業務ではガッツリ使われているので廃止できない というレガシープロジェクトばかりでした。この記事では、レガシープロジェクトを引き継いでしまった時に、最初