わかりやすい技術文書へのアプローチ
技術文書の「書き方」−共通のポイントと各種文書への応用−


書く」による知的生産


当コーナーのポイントの整理

最後までご覧いただき有難うございます.各種の技術文書を効率よく作成する手法をテクニカルライティングのポイントで解説しました.当コーナーでお話したのは,段落のアウトライン(輪郭)です.無理に型に当てはめるととらず,各種の技術文書を作成する際の“きっかけ”とご理解いただければ幸いです.

ポイント1:段落を「主文」と「補足文」で構成する

ポイント2:文書目的(主たる視点)に応じた「主文」の候補を用意しておく

ポイント3:文構成が行き詰まる原因を知り,その解決策を知っておく

当コーナーの最初で述べたように,これらのポイントはさまざまな技術文書で積み重ねられかつ読者に受け入れられてきた「技術を文書で伝える技術」のエッセンスです.技術的な課題を解決する際と同様に,技術文書を作成する場合も「基本となる論理とそれから導かれる手法」を理解して実務に臨むことが重要と言えます.


書く」から導かれる知的生産力

文書作成は,まさに「知的生産」です.直接の代価に結びつく商品の生産とは比較できませんが,ノウハウを「文書」に表す行為は開発・製造のみならず技術系企業の多くの部署で重要な位置付けにあります.

企業にとっての文書作成の重要性とともに,企業を構成する人々にとっても「書く」という行為は「新たな着想」,「埋もれていた発想の再認識」さらには「個別の事象からの関係性 (共通性,相反性など)の発見」につながります.


当社の願い

当社の願いは,技術者の皆さんに「テクニカルライティング」を知っていただき,技術文書の作成に役立てていただくことです. 品質が高い技術文書を不要な時間をかけることなく作成できれば,業務の効率化と企業の利益につながると確信します.

繰り返しになりますが, 「テクニカルライティング」はすでに技術者の皆さんが獲得した技術文書の知識あるいは経験を否定するものではありません.むしろ,知識と経験の整理であり,必要な補完とも言えます.

「書くのに時間がかかる」あるいは「書いても十分に伝わらず,問合せの対応をせまられる」から生じる損失をなくし,「知的財産である技術文書の価値を戦略的に高める」とともに「企業の業務を効率化する」ために,技術文書とテクニカルライティングに関心を寄せていただくことを願っています.

山之内総合研究所

山之内孝明(山之内総合研究所・代表)

takaaki@yamanouchi-yri.com



テクニカルライティングセミナー

テクニカルライティングセミナー(出張開催形式)技術の1stステップ」,(同)+技術メール編」,(同)+ビジネス文書編」では,要点が明確な技術文書を作成するための共通基礎と手法を事例中心で解説します.

.


 

当社の実務別技術文書セミナー
わかりやすい技術文書の作成手法との違い

テクニカルライティングセミナー「技術文書の1stステップ」の各編は,技術文書を作成する際の共通基礎を主体に構成されています.

対して,「わかりやすい技術文書の作成手法」の各編は文書目的ごとに「いかに文書を構成し,まとめるか 」を主体に構成されています.


技術文書の共通基礎と「要点がわかる」文書作成のポイントを解説 します.


.



技術文書の1stステップ」に技術メールのポイント,敬語表現の使い方を追加した拡張版です.


「技術文書の1stステップ」にビジネス文書(社内文書・社外文書)の基本,敬語表現の使い方を追加した拡張版 です.

.

実務別技術文書セミナー

実務別技術文書セミナー(出張開催形式)わかりやすい技術文書の作成手法」は,業務で作成する機会の多い文書に応じた「コース選択式」です.各コースごとに必要な考え方・手法・ポイントを事例中心で解説します.

.
   わかりやすい技術文書の作成手法







.

.

 


マニュアル作成セミナー

マニュアル作成セミナー(出張開催形式)わかりやすいマニュアルの作成手法」では,「これからマニュアルを作成する」あるいは「見直しをしたい」方々のために基礎と実務知識実用例・参考例で解説します.

.



取扱いマニュアル(家電製品・情報機器,試験装置・製造装置,その他)を作成する際のポイントを基本と事例で解説します.


システム操作マニュアル(電子申請システム,情報検索システム,業務支援システム,その他)を作成する際のポイントを基本と事例で解説 します.

.



システムを導入した業務(顧客対応,各種管理など)のマニュアルを作成する際のポイントを基本と事例で解説します.


製造工程での組立て作業あるいは製品の整備・改修作業などを想定した作業手順書のポイントを基本と事例で解説します.

.


 

製品あるいはソフトウェアの操作を図解でわかりやすく示す「図解マニュアル」を作成する際のポイントを基本と事例で解説します.


 
.

 



テクニカルドキュメント・ビジネスドキュメントためのテクニカルライティングセミナー
わかりやすい技術文書・ビジネス文書の作成手法
技術文書の「書き方」−共通のポイントと各種文書への応用−
Copyright:Takaaki-YAMANOUCHI/1995-2010
山之内孝明/(有)山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.