ハマログ

株式会社イーツー・インフォの社員ブログ

ドキュメントなどの書き方について

今までに、色んな会社を転々としてきてドキュメントや、作業指示の書き方にも色々とパターンがあるなと思ったので書いてみます。

■短文小説型

几帳面な人によくありがちな、詳細な内容をひたすら気の済むまで書いてしまうタイプ。

「○○は××で、このような経緯でこの作業が必要になり、毎月いつまでにどのように作業を行う必要がある。また、その際△△と□□が××で・・・」

のように、最後まで読んでみると結局何が言いたかったのか良くわからない事もしばしば・・・

読んでいる途中で他の人に話しかけられると、最初から読み直しなんて事にもなります。

■もはや何も書かない

バックログやRedmineの概要欄に一言だけ「やる」「いつまでに対応する」のようなコメントが残されるパターン。

属人化した案件などで、自分しか触らないし、自分がわかっていれば良い時に発生しがち。

私もたまにやってしまうので、後々の事を考えて意識を改めます。

この手の課題や資料に関しては、その時は良いかもしれないですが、担当者が辞めた時に後任者がとてつもないストレスを抱える事になるので絶対に辞めた方が良いです。

■突然変異型

今までに出会った中でもかなり特殊なケース。

ファイル名で意思表示

こんな感じの顔になりました。

・・・え?何が?って感じでした。

なぜこの手段を選択したのかは不明ですが、誰も得をしないので絶対に辞めた方が良いです。

■まとめ

作業手順書のようなものであれば、「何の為に行う作業なのか」「作業手順」「意図する作業結果」などがまとめてあると個人的にはとてもありがたいです。あわよくば手順のキャプチャなどもあると尚良いです。

各種ドキュメントについても、長文過ぎず、短すぎず、端的に要点がまとめてあるようなドキュメントが好きです。

人それぞれ好みはあると思うので、色んなドキュメントの書き方を見て自分なりのベストをこれからも探求し続ける所存です。


  tm   2022年4月1日


関連記事

Windows環境のPhpStorm+GitでCodeCommitからCloneする

ちょっとハマったのでメモCodeCommitにリポジトリを作りました。時代はHT…

テスト設計技法 – 同値分割法

どうもーyasuです~ 最近暑くなってきましたー 洗濯物がよく乾く! 前回のブロ…

ITツールの機能紹介-GoogleChromeのタブグループ機能-

つーじーです。名前が「つーじー」「つ~じ~」と表記揺れがあることに最近気づきまし…


← 前の投稿

次の投稿 →