skillup

技術ブログ

ドキュメント作成

ドキュメント作成について

投稿日:

アプリやプロジェクトのドキュメント作りですが、時間が立ったり、複数人での開発を行うと

  • 情報の漏れや抜けが非常に多くなる
  • 本番との差分ができる
  • 一部の人しか更新しなくなる
  • 似たようなドキュメントがあちこちにできる

などなど完全には機能しなくなることが一般的です。

人間がやる以上、完全に機能させることは難しいのですが、

大原則としてシステムやコードから起こすのが大切になってくると思います。またそのドキュメントを作らないとプロジェクトが進まないようにすることも大切だと思います。

それを体系化したものがCIという考えだと思いますが、要点としては開発に絶対必要なプロセスに組み込むことだと思います。

例としては

  • Gitのpushの際にドキュメントを作る
  • ドキュメントのプロセスがないと本番にpullできない

などでしょうか。

ちなみに自分は一人で開発を進めることも多かったため、あまりドキュメントを残さずにとりあえずコードを書くということが一般的でした・・(汗)

最近はサーバーとフロント側で仕事を分けたりして進めることが多いのですが、そうなるとどうしても情報を共有する必要が出てきます。

また短納期、小規模な開発が多かったため、ゆったりと開発することはできません。

私はドキュメント作成があまり好きではないのですが、機能しなくなるのと、そのための開発時間を取られるからです。

それを両立する方法はないかな、と頭を悩ませていました。

色々試行錯誤し、まだ実験段階ですが、テストコードの活用が鍵になる気がします。

テストコードを作る過程でドキュメント作成(あるいはそれに相当するもの)を作ることができるからです。

もちろんコードの書き方自体が正しい必要はありますが、テストコードをうまく書くことによって

  • システムからドキュメントを作れる
  • ドキュメント作りの時間(開発できない時間)がへる

といったことが実現できるのではないかと思います。

 

-ドキュメント作成
-

執筆者:


  1. […] ドキュメント作成について […]

comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

新アプリの本番環境デプロイについて

新しく作ったWEBアプリを本番配置しようとしたんですが、何度もやっているはずの処理がいざやろうとするといろいろと手間取ってしまい、1時間近くかかりました。 容量悪いなーと思いつつ、こういった行為はなる …

no image

障害報告などでの伝える情報の視点

障害の重要度(後続タスクにブロックがあるかいなか)、調査原因(仕様不理解、設計考慮もれ、ケアレスミス)、影響度(画面単位などで) 障害が起こっているデータ(あるいはスクショなどで伝えられるか) 再現プ …

no image

EntityとValue Objectについて

ドメイン駆動設計に関して勉強しています。参考にしている本がやたら難しいんで、トピックごとにネットで調べつつ進めていくのがよさげです。 今回はEntityとValueObjectについて Content …

no image

APIに関して

RESTAPIのルーティングで気をつけることなんぞを。 直近のプロジェクトではRESTAPIを作ることが多かったんですが気をつけることなんぞを。 Contents1 仕様書はソースから2 ツール3 命 …

no image

開発時最低限必要かつ有用なドキュメントに関して

ウォーターフォール型の開発をかれこれ1年近くやっております。 自分がやってきた仕事とすると別職種に近いようなイメージでしたが、得ることも多かったため、ここに記しておこうと思います。 以前書いたことの記 …