プロの作家への依頼

※上記の広告は60日以上更新のないWIKIに表示されています。更新することで広告が下部へ移動します。

Hiroは、決算システムの設計の覚書や関連するプロジェクトに関するドキュメントを作成する必要があった。こうしたドキュメントを人事異動の際に、後任者へ引き継ぐことで、後任者は背景知識などを知ることができる。しかし、Hiroは技術は持っているが文書能力は低く、第三者が理解できる文章を書くことが苦手である。

後任者が読んで理解のできるドキュメントを作成するには、どのようにするべきか?

ドキュメントを作成し、人事異動の際に後任者に引き継ぐことは重要なことであるが、こうした内部ドキュメントは参照されることは少ない。エンジニアのコミュニケーション能力は優れていないことが多いからだ。
また、開発者自身は、ドキュメントを作成を後回しにしがちである。
幸い社内システム部では、Hiroの同僚のJoeは文章能力に優れた人材であり、彼がシステムの成果物の作成を行っている。

わかりやすいドキュメントを作成する第三者(プロ)にドキュメントの作成を依頼しよう

HiroはJoeに対し決算システムの技術的なドキュメント化に関して上司であるYoshiakiを通して依頼をした。
その結果、決算システムに関して読みやすいドキュメントが完成し、異動期にHiroは後任者のKeiに読みやすいドキュメントを引き継ぐことができた。しかし、プロライターのロールを演じ切ることは難しい。もし、適切な人材が存在しない場合は利害関係の少ないテクニカルライターを外部から見つけて、雇うべきである。
また、Joeによって作成されたドキュメントに関し、内容に誤りがないかHiroがレビューをする必要がある。

プロ作家への依頼によって、引き継ぎ資料へのレビュー業務知識の拡散が自動的に実施される。また、わかりやすい目次も自動的に実行されることがある。
また複雑な文書の作成を、プロ作家へ行う再、実践させるも併用することで、後任者の理解が深まることが期待される。
添付ファイル