こんにちは、エンジニアの玉川です 開発をする上で必要になる仕様書。 開発者は仕様書の大切さを一番知っていると私は思います。 仕様書の管理方法は会社によって様々でしょう。 弊社では、仕様の運用管理にGitHubを使用し、仕様書の形式をマークダウン形式で作成するようにしました。 今回はそのTipsについて書いていきます。 仕様書管理で直面した2点の問題 仕様書等のドキュメント管理はエクセルなどで管理されることが多いと思いますが私は2点問題があると考えています。 1. 仕様の変更があったが仕様書の変更をしたかどうかがわからない 2. 作成者のリッチテキスト編集能力に差が出てしまい、編集だけに時間がかかり使わなくていい時間が大幅にかかってしまう この2点を解消するために、 管理をGitHubに。仕様書をマークダウンで書いていくようにしました。(今回はGitbookは使用しませんでした) 2つを選ぶ