誠ブログは2015年4月6日に「オルタナティブ・ブログ」になりました。
各ブロガーの新規エントリーは「オルタナティブ・ブログ」でご覧ください。

技術屋のためのドキュメント相談所、始めます

技術屋のためのドキュメント相談所、始めます

開米 瑞浩

IT技術者経験をバックグラウンドに、技術系の専門的な情報を「分かりやすく書く」スキルの指導を得意とするドキュメント・コンサルタント。技術者向け文書作成研修経験多数。

当ブログ「技術屋のためのドキュメント相談所」は、2015年4月6日から新しいURL「​http://blogs.itmedia.co.jp/doc-consul/」 に移動しました。引き続きご愛読ください。


 世の中に、技術屋さんは大勢います。
 そして、技術に関わる問題を立場が違う人に説明することがうまくできずに困っていることが多いものです。
 例えばこんな悩み、身に覚えはありませんか?

・ケース1:
ユーザーさんに提出するシステム仕様の説明書や障害報告書について、「専門用語ばかりで分かりにくい」と言われてしまいます。

・ケース2:
自社の現行のシステムには重大な懸念事項があるため、早急に対応する必要があることを報告したのですが、取締役に「お前の話は要するに何が言いたいのか分からん!」と言われてしまい、かといってどう伝えれば分かってくれるのか見当もつかないので、気力がくじけてしまいそうです。

・ケース3:
ユーザーから要求仕様のヒアリングをすると箇条書きがたくさんできますが、箇条書きのままだと全体としてどう関連付いているかが分からず、ユーザーとイメージを共有できません。そこで全体のイメージを要領よくまとめた図に表したいのですが、どう書いていいのか分からず困っています。

 そんな技術屋さんの強い味方になるのが「分かりやすく書く力」、特に「図解の力」です。
 このブログでは、技術的な情報を「わかりやすく図解する」事例を中心に、技術系ドキュメント・コンサルタントの開米瑞浩が、ドキュメントの悩みを解決するためのヒントをお届けします。