知って得・あなたの生活をもっと豊かに!

こんにちは、拙作ブログのご紹介です。このブログは河原健次がお届けしています。大分市出身、木更津市在住です。すでに半世紀以上も生存しています。その長い歴史から、日常生活や人生に参考になりそうな情報を提供しています。読者のみなさんに役立つことを願っています。

技術文書の書き方、心がけたい6つのポイント

f:id:kawa2496:20190307184656j:plain


こんにちは。
拙作ブログをご覧いただきありがとうございます。

今回は技術文書の書き方です。
といっても、難しいことを書くつもりはありません。


私は技術屋として、
大手鉄鋼メーカーに勤務していました。

コンピュータ屋さんです。

 

そこでの経験を少しだけ書いてみたいと思います。


いわば、
実体験から得たノウハウのようなものです。

何かの参考になればと思っています。

題して、
 技術文書の書き方、
 心がけたい6つのポイント

です。

【6つのポイント】
1)正確に漏れなく。
2)分かりやすく。
3)読みやすく。
4)「基本的考え方」が大事。
5)思考過程を残す。
6)改訂履歴も残す。

では、さっそく見ていきましょう。

 

 

 

1.正確に漏れなく

技術文書に限らず、
すべての文書は正確性完全性が命です。

1)正確に。
とくに技術文書では正確さが求められます。
というのは、その技術文書がもとになって、
次の研究開発や技術開発が行われるからです。


多少分かりににくくても、
正確さに心がけてください。

 

2)漏れなく。
これも大事です。
技術文書は成果報告ですので、
技術成果をすべて書くことが求められます。


仮に、その技術成果が不満足であっても、
また、不本意な結果に終わったとしても、
すべて書いてください。


ただし、書き方は、一工夫いります。


本結果と副次結果とは分けて、
誤解されないようにしましょう。


このへんは、後述します。

 

2.分かりやすく

この分かりやすさも、
技術文書に限った話ではありません。


一般の文書にもいえます。

 

2-1.分かりやすくを勘違いしないように

分かりやすくとは、
一般の読者に対してです。


特定の専門技術者だけが
分かってもダメです。

 

技術者はここのところを
勘違いしています。

 

やたらに、専門用語を使いたがる傾向があります。


私にいわせれば、
専門用語を使いたがる人にかぎって、
自分の技術に自信がない人が多いようです。


あえて難しい用語を使って、
自分を偉くみせようとしている
のではないでしょうか。


それとも、
読者を煙に巻こうとしているのでしょうか。

 

2-2.平易な言葉を

いずれにしても、
専門用語の乱用は、
技術文書の目的を逸しています。


百害あって一利なしです。

 

最悪、専門用語を使う場合は注釈を入れてください。

可能な限り平易な言葉で書いてください。

技術文書、イコール、難しい文書。

これでは困ります。

 

2-3.簡潔に

読みやすくの、極めつけ「簡潔に」です。


文章がくどいと、思考が混乱します。


言いたいところを、簡潔に書きましょう。
いくら正確な技術文書でも、
読んでもらえなければ意味がありません。

どんな文書でも、読まれてなんぼです。

 

3.読みやすく

これは、多少前項とダブりますが、
「読みやすく」に徹してください。

1)ストーリーに工夫を。

これも普通の文書と同じです。
全体のストーリーに工夫をしてください。


◆起承転結が基本ですが・・
起承転結が基本となるのは、技術文書でも同じです。
ただ、少しだけ違うところもあります。


以下は代表的なストーリーです。


①概要(緒言ともいいます)
※ここに「結論」を書きます。
②目的
③前提条件
④設備仕様(実験設備を含む)
⑤結果
⑥結果の考察
⑦課題
⑧まとめ(結言)

ポイントは、
文書の冒頭に結論を
持ってくるところです。

2)図、表、写真を多用。

 

f:id:kawa2496:20190121072052p:plain

分かりやすくする方法の具体例は、
図、表、写真を多用することです。


とくに図は有効です。
(上図参照)


口頭で説明するときでも、
図を中心に行ったほうが、
分かりやすくなります。


また、写真も有効です。
写真はさらに「リアル感」増します。
このように図や写真は、
インパクトを与えるのに一番有効な手段です。

3)アクセントも。

文書にアクセント(メリハリ)も大切です。


上記の図、表、写真もその一つですが、
それ以外に、見だしや文章に一工夫してください。
◇見だし:文字の大きさ、色を変える。
◇タイトル:一目で分かるような文言にする。
◇文章:強調したいところの文字を変える。
大きさ字体など

 

4.「基本的考え方」が大事

ここからが、技術文書特有の心得になります。
注意してみてくださいね。

まず「基本的考え方」ですが、
これは、技術文書の対象となった作業(研究や開発)の
基本的な考え方を記載するものです。


別な言い方をすると以下のようになります。


①コンセプト(概念)
②フィソロフィー(哲学)

分かりにくいですね。
例で説明しましょう。

【例】システム構築
基本的考え方のサンプル1:コストミニマム
基本的考え方のサンプル2:最新技術の導入

これで分かりましたよね。
ようは、
技術開発などにおいて、
どこに力点を置くか
を明確にすることです。


これがハッキリしていないと、
評価ができないからです。


この「基本的考え方」は、作業中(技術開発中)の、

「道しるべ」となるものです。

よって、
もっとも重要なものとなります。

ただ、この「基本的考え方」は、とかく忘れがちです。

作業者の頭の中にはあるのでしょうが、
文書として残していません。

 

これは不幸です。
問題です。

折角の技術文書にコンセプトがないのは、
家でいうと土台がないようなものです。

是非、記入するようにしてください。

 

5.思考過程を残す

次に技術文書で大事なものが思考過程です。
この思考過程も忘れがちなので注意してください。

1)思考過程とは。

思考過程とは、結論に至った過程です。


①複数案を考案した理由や背景。


②その案の中から、
最終案になるまでの経緯、理由。


こういうものを思考過程といいます。

2)なぜ忘れるのか。

思考過程の記述は、技術文書から忘れがちです。

それは、結果だけに気持ちが行くからです。


結果、イコール、報告対象

となるからです。
結果だけが評価されるからです。

 

3)なぜ大事なのか。

思考過程の大切さは下記にあります。


①技術伝承。

この思考過程は、まさに「技術」です。

 

あるいは、
ノウハウ(知恵)といってもよいでしょう。


これを第三者に伝承する必要があります。

(自分自身への伝承という意味もあります)


技術伝承は、
技術開発では大事な使命です。


②自己反省、自己確認。

思考過程を書き留めることは、
自己反省、自己確認にもなります。


つまり、書くことによって、
頭の中が整理できるのです。

 

6.改訂履歴も残す

最後の心得は「改訂履歴」です。
他の文書でもそうでしょうが、
文書の完成後に改訂が発生します。
改訂理由にはいろいろとありますが、
一番大事なのは、知見の追加、変更です。
つまり、追加の実験や仕様の追加変更です。
とくに、プロパー設備ではよくある話です。

この履歴を技術文書に残しておきます。

【具体例】
改訂01)○○年○○月○○日
 ××仕様の追加に伴い、△△を追加。

上記を時系列に列挙しておきます。

これも技術の蓄積の一つです。
技術伝承にもなります。

 

7.まとめ

f:id:kawa2496:20190307184240j:plain


どうでしたか。
技術文書のポイントがお分かりになったでしょうか。

なんとなく分かったとしても、
それが自分のものになるまでには、
相当の時間がかかります。

1)実務だけでも大変なのに。

正直いって技術文書まで手が回りません。
設備が完了した時点で、エネルギーを使い果たしています。


「結果の報告なんて、適当でいいや」
「設備さえ動けばいいじゃん」


となりがちです。

私も、かつては、そうでした。

 

2)残ったのは目の前の設備だけですか。

しかし、技術文書がなおざりになると、


あなたの汗と苦労は、
目の前の設備だけとなります。

 

目の前の設備に、
あなたの汗が残っていますか。

あなたの苦労がみえますか。

 

あなたの足跡は、技術文書しかありません。


その技術文書がないと、
後に続く技術者が、
あなたと同じ苦労をしなければなりません。

そこのところを、よく考えてくださいね。

 

最後までお読みいただき、
ありがとうございました。

 

【更新】2019年9月5日
「目次」を追加しました。
これで少しは読みやすくなったと思います。

 

 

 

 


「わかりやすい」文章を書く全技術100

理工系の技術文書作成ガイド

入門 考える技術・書く技術――日本人のロジカルシンキング実践法

考える技術・書く技術―問題解決力を伸ばすピラミッド原則

技術系英文ライティング教本: 基本・英文法・応用

技術翻訳のチェックポイント―技術文書の作成と評価

入門 考える技術・書く技術

技術士第二次試験 合格する技術論文の書き方 (国家・資格試験シリーズ 382)

10倍速く書ける 超スピード文章術

技術文書の書き方: Wordで作成してKindleで出版する

学びを結果に変えるアウトプット大全 (Sanctuary books)

即効! 成果が上がる 文章の技術 (アスカビジネス)

超・箇条書き―――「10倍速く、魅力的に」伝える技術

理科系の作文技術 (中公新書 (624))

英文技術文書の作成+用語集 ~開発・製造の実務英語~