SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

EnterpriseZine(エンタープライズジン)編集部では、情報システム担当、セキュリティ担当の方々向けに、EnterpriseZine Day、Security Online Day、DataTechという、3つのイベントを開催しております。それぞれ編集部独自の切り口で、業界トレンドや最新事例を網羅。最新の動向を知ることができる場として、好評を得ています。

最新イベントはこちら!

Enterprise IT Women's Forum

2025年1月31日(金)17:00~20:30 ホテル雅叙園東京にて開催

Security Online Day 2025 春の陣(開催予定)

2025年3月18日(火)オンライン開催

EnterpriseZine(エンタープライズジン)編集部では、情報システム担当、セキュリティ担当の方々向けの講座「EnterpriseZine Academy」や、すべてのITパーソンに向けた「新エバンジェリスト養成講座」などの講座を企画しています。EnterpriseZine編集部ならではの切り口・企画・講師セレクトで、明日を担うIT人材の育成をミッションに展開しております。

お申し込み受付中!

EnterpriseZine(エンタープライズジン)

EnterpriseZine編集部が最旬ITトピックの深層に迫る。ここでしか読めない、エンタープライズITの最新トピックをお届けします。

『EnterpriseZine Press』

2024年秋号(EnterpriseZine Press 2024 Autumn)特集「生成AI時代に考える“真のDX人材育成”──『スキル策定』『実践』2つの観点で紐解く」

'); googletag.cmd.push(function() { googletag.pubads().addEventListener('slotRenderEnded', function(e) { var ad_id = e.slot.getSlotElementId(); if (ad_id == 'div-gpt-ad-1652772241096-0') { var ad = $('#'+ad_id).find('iframe'); if ($(ad).width() == 728) { var ww = $(window).width(); ww = ww*0.90; var style = document.createElement("style"); document.head.appendChild( style ); var sheet = style.sheet; sheet.insertRule( "#div-gpt-ad-1652772241096-0 iframe {-moz-transform: scale("+ww/728+","+ww/728+");-moz-transform-origin: 0 0;-webkit-transform: scale("+ww/728+","+ww/728+");-webkit-transform-origin: 0 0;-o-transform: scale("+ww/728+","+ww/728+");-o-transform-origin: 0 0;-ms-transform: scale("+ww/728+","+ww/728+");-ms-transform-origin: 0 0;}", 0 ); sheet.insertRule( "#div-gpt-ad-1652772241096-0 div{ height:"+(90*ww/728)+"px;width:"+728+"px;}", 0 ); } else { if ($(window).width() < 340) { var ww = $(window).width(); ww = ww*0.875; var style = document.createElement("style"); document.head.appendChild( style ); var sheet = style.sheet; sheet.insertRule( "#div-gpt-ad-1652772241096-0 iframe {-moz-transform: scale("+ww/320+","+ww/320+");-moz-transform-origin: 0 0;-webkit-transform: scale("+ww/320+","+ww/320+");-webkit-transform-origin: 0 0;-o-transform: scale("+ww/320+","+ww/320+");-o-transform-origin: 0 0;-ms-transform: scale("+ww/320+","+ww/320+");-ms-transform-origin: 0 0;}", 0 ); sheet.insertRule( "#div-gpt-ad-1652772241096-0 div{ height:"+(180*ww/320)+"px;width:"+320+"px;}", 0 ); } } } }); }); } else { document.write('
'); document.write('
'); }
ドキュメント力を強化したい人のためのマニュアルライティング入門講座

ちょっとした構成案を作れば、あなたのドキュメントはもっとわかりやすくなる!

第1回

システムの開発において、ドキュメントの作成は避けて通れません。一方で、文書の書き方についてキチンと習ったよ、という方は案外少ないのではないでしょうか。どうせなら、読み手に「わかりやすい!」と言ってもらえるドキュメントを書きたいですよね。この連載では、マニュアルライティングの基本中の基本を解説していきます。

わかりにくい手順書・マニュアルが仕事を増やしていませんか?

 システムが稼働し始め、初期のトラブルもつぶしたにも関わらず、何故か問い合わせは終わらない状況が続く。今日もお客様からせっぱ詰まった様子の電話が…。

  「月末処理をしていて、

   仮に入れた数値をすぐに変更したいんですが、できないんです。

   何とかしてください」

 「それなら、こうすればできますよ。まずメニューの…」と、手順を説明したところ、どうやらうまくいった様子です。「手順書にだってちゃんと書いておいたし、難しい操作でもないのに。おかしいなぁ」「ちゃんと読んでから、操作して欲しいよ」なんて思っていませんか?

 このような状態は、わかりにくい手順書やマニュアルが引き起こしている場合が、しばしばあるのです。手順書やマニュアルに「書いてあるつもり」「わかるように説明しているつもり」であっても、読み手であるお客様にとっては「必要なことが書かれていない…」「わかりづらくて操作ができない…」と受け取られていたら、問い合わせがくるのは当たり前。

 また、情報が不足していたり、誤解を招く書き方をしていたら、お客様から問い合わせがきたり、トラブルを引き起こすのも、当然と言えば当然です。

  「もっとちゃんと書いておいてくれれば、こんなトラブルはなかったのに…」

 これではお客様から信頼を得ることはできません。

cap

わかりやすいマニュアルはシステムの価値を高める

 「システムの良さ、技術力では負けないのに、他社と比べて提案力やサポートが弱いと言われてしまう…」このような状況も、ドキュメント(文書)のわかりづらさが原因となっていることがあるようです。

 システムやソフトウェアという形がないものを、相手に説明し、提案し、使いこなしてもらうために、提案書や要件定義書やマニュアルがあります。ですから、それらのドキュメントがわかりやすくできていなかったとしたら、システムやソフトウェアの良さをお客様に十分理解していただけてはいないことになります。

 「使ってみればわかる」では、ダメなのです。その良さを十分に理解してもらい、さらに活用してもらうための的確な情報を提供すること。それがドキュメントの役割です。良いドキュメントは、競争力を高めます。わかりやすいドキュメントでシステムの価値を高め、技術力をしっかりお客様に伝えるよう、発想の転換をしてください。

次のページ
まずは構成案を作るにあたって確認から

' ); }

この記事は参考になりましたか?

  • Facebook
  • X
  • Pocket
  • note
ドキュメント力を強化したい人のためのマニュアルライティング入門講座連載記事一覧

もっと読む

この記事の著者

高橋 慈子(タカハシ シゲコ)

テクニカルライター。テクニカルコミュニケーションの専門会社 株式会社ハーティネス 代表取締役。マニュアル制作や改善に携わるほか、わかりやすく書く技術を盛りこんだ企業研修なども行っている。

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

この記事は参考になりましたか?

この記事をシェア

EnterpriseZine(エンタープライズジン)
https://enterprisezine.jp/article/detail/917 2008/12/24 09:00

Job Board

AD

' ); document.write(''); } $(window).on('load', function() { // 中身が無い広告でslotOnloadを通らない場合がある var show_ad = 0; dfp_job_board.map(function(ad_id) { var ad = $('#'+ad_id[0]).find('iframe').last(); var contents = ad.contents(); if (contents.find('body').length === 0 || !contents.find('body').html()) { $('#' + ad_id[0]).remove(); //$('#' + ad_id[0]).attr('class', 'noad'); } else { show_ad++; } }); if (show_ad == 0) { $('.ad-job-board-wrap-sp').hide(); } }); } else { $('.ad-job-board-wrap-sp').hide(); }

おすすめ

アクセスランキング

  1. 1
    NICTのサイバーセキュリティ研究所長が語る、不足が深刻な「セキュリティ人材」育成の有効策とは? NEW
  2. 2
    マイクロソフト「Ignite 2024」発表の最新事例:AIエージェント化するCopilotの進化とは?
  3. 3
    生成AI活用を阻む3つの課題 汎用型LLMと共存する「自社特化型LLM」構築のポイントとは
  4. 4
    大規模システム障害を経たみずほ“IT運用改革”の今 7万パターンの障害対応は生成AIで自動化できるか
  5. 5
    ETLで絡み合った“スパゲティ状態”の統合基盤解消法とは モダナイズの肝「SoE」システム構築を解説 NEW
  1. 6
    ソニーグループの生成AI活用が本格化──内製「Enterprise LLM」とベクトルDBによる独自の環境構築
  2. 7
    COBOL・JCL・PL/I……みずほリサーチ&テクノロジーズが1年で挑んだメインフレームオープン化
  3. 8
    生成AIのハルシネーション克服へ RAG構築における「データ構造化」の4つのポイントとは?
  4. 9
    創業112年のヤンマーがAI時代を見据えてデータ基盤を再構築中 “全社資産”として活用へ
  5. 10
    ヤマハ発動機のサイバーセキュリティは「アクセル」でありたい──グローバル・取引先とともに進める

アクセスランキング

  1. 1
    NICTのサイバーセキュリティ研究所長が語る、不足が深刻な「セキュリティ人材」育成の有効策とは? NEW
  2. 2
    マイクロソフト「Ignite 2024」発表の最新事例:AIエージェント化するCopilotの進化とは?
  3. 3
    生成AI活用を阻む3つの課題 汎用型LLMと共存する「自社特化型LLM」構築のポイントとは
  4. 4
    大規模システム障害を経たみずほ“IT運用改革”の今 7万パターンの障害対応は生成AIで自動化できるか
  5. 5
    ETLで絡み合った“スパゲティ状態”の統合基盤解消法とは モダナイズの肝「SoE」システム構築を解説 NEW
  6. 6
    ソニーグループの生成AI活用が本格化──内製「Enterprise LLM」とベクトルDBによる独自の環境構築
  7. 7
    COBOL・JCL・PL/I……みずほリサーチ&テクノロジーズが1年で挑んだメインフレームオープン化
  8. 8
    生成AIのハルシネーション克服へ RAG構築における「データ構造化」の4つのポイントとは?
  9. 9
    創業112年のヤンマーがAI時代を見据えてデータ基盤を再構築中 “全社資産”として活用へ
  10. 10
    ヤマハ発動機のサイバーセキュリティは「アクセル」でありたい──グローバル・取引先とともに進める
  1. 1
    生成AIのハルシネーション克服へ RAG構築における「データ構造化」の4つのポイントとは?
  2. 2
    「能動的サイバー防御で日本は“蚊帳の外”」名和利男氏、新井悠氏、辻伸弘氏が示す官民連携への道筋
  3. 3
    大規模システム障害を経たみずほ“IT運用改革”の今 7万パターンの障害対応は生成AIで自動化できるか
  4. 4
    三菱UFJ銀行が“生成AI”活用にアクセル、グループ企業への展開も視野にいれた新プロジェクトの狙いは
  5. 5
    ヤマハ発動機のサイバーセキュリティは「アクセル」でありたい──グローバル・取引先とともに進める
  6. 6
    会員1億人超「dポイント」の安定稼働を支える大規模インフラ共通基盤:ドコモ情シスが挑む3大DXに迫る
  7. 7
    「ソブリンクラウド」がクラウド業界の局面を変える──エンジニアのスキルセットも変化、人材育成が障壁に
  8. 8
    「アイデンティティ管理」と共にキャリアを積んだ、Okta リージョナルCSO板倉氏に聞く
  9. 9
    ガートナーやAWSの戦略に捉われるな!情シスが陥りがちな失敗する“システム起点”モダナイゼーション
  10. 10
    アクティビスト対応は経営変革のトリガー ── DNP とJ.フロントリテイリングが語るCFO組織の役割とは

イベント

EnterpriseZine(エンタープライズジン)編集部では、情報システム担当、セキュリティ担当の方々向けに、EnterpriseZine Day、Security Online Day、DataTechという、3つのイベントを開催しております。それぞれ編集部独自の切り口で、業界トレンドや最新事例を網羅。最新の動向を知ることができる場として、好評を得ています。

新規会員登録無料のご案内

メールバックナンバー

アクセスランキング

  1. 1
    NICTのサイバーセキュリティ研究所長が語る、不足が深刻な「セキュリティ人材」育成の有効策とは? NEW
  2. 2
    マイクロソフト「Ignite 2024」発表の最新事例:AIエージェント化するCopilotの進化とは?
  3. 3
    生成AI活用を阻む3つの課題 汎用型LLMと共存する「自社特化型LLM」構築のポイントとは
  4. 4
    大規模システム障害を経たみずほ“IT運用改革”の今 7万パターンの障害対応は生成AIで自動化できるか
  5. 5
    ETLで絡み合った“スパゲティ状態”の統合基盤解消法とは モダナイズの肝「SoE」システム構築を解説 NEW
  1. 6
    ソニーグループの生成AI活用が本格化──内製「Enterprise LLM」とベクトルDBによる独自の環境構築
  2. 7
    COBOL・JCL・PL/I……みずほリサーチ&テクノロジーズが1年で挑んだメインフレームオープン化
  3. 8
    生成AIのハルシネーション克服へ RAG構築における「データ構造化」の4つのポイントとは?
  4. 9
    創業112年のヤンマーがAI時代を見据えてデータ基盤を再構築中 “全社資産”として活用へ
  5. 10
    ヤマハ発動機のサイバーセキュリティは「アクセル」でありたい──グローバル・取引先とともに進める

アクセスランキング

  1. 1
    NICTのサイバーセキュリティ研究所長が語る、不足が深刻な「セキュリティ人材」育成の有効策とは? NEW
  2. 2
    マイクロソフト「Ignite 2024」発表の最新事例:AIエージェント化するCopilotの進化とは?
  3. 3
    生成AI活用を阻む3つの課題 汎用型LLMと共存する「自社特化型LLM」構築のポイントとは
  4. 4
    大規模システム障害を経たみずほ“IT運用改革”の今 7万パターンの障害対応は生成AIで自動化できるか
  5. 5
    ETLで絡み合った“スパゲティ状態”の統合基盤解消法とは モダナイズの肝「SoE」システム構築を解説 NEW
  6. 6
    ソニーグループの生成AI活用が本格化──内製「Enterprise LLM」とベクトルDBによる独自の環境構築
  7. 7
    COBOL・JCL・PL/I……みずほリサーチ&テクノロジーズが1年で挑んだメインフレームオープン化
  8. 8
    生成AIのハルシネーション克服へ RAG構築における「データ構造化」の4つのポイントとは?
  9. 9
    創業112年のヤンマーがAI時代を見据えてデータ基盤を再構築中 “全社資産”として活用へ
  10. 10
    ヤマハ発動機のサイバーセキュリティは「アクセル」でありたい──グローバル・取引先とともに進める
  1. 1
    生成AIのハルシネーション克服へ RAG構築における「データ構造化」の4つのポイントとは?
  2. 2
    「能動的サイバー防御で日本は“蚊帳の外”」名和利男氏、新井悠氏、辻伸弘氏が示す官民連携への道筋
  3. 3
    大規模システム障害を経たみずほ“IT運用改革”の今 7万パターンの障害対応は生成AIで自動化できるか
  4. 4
    三菱UFJ銀行が“生成AI”活用にアクセル、グループ企業への展開も視野にいれた新プロジェクトの狙いは
  5. 5
    ヤマハ発動機のサイバーセキュリティは「アクセル」でありたい──グローバル・取引先とともに進める
  6. 6
    会員1億人超「dポイント」の安定稼働を支える大規模インフラ共通基盤:ドコモ情シスが挑む3大DXに迫る
  7. 7
    「ソブリンクラウド」がクラウド業界の局面を変える──エンジニアのスキルセットも変化、人材育成が障壁に
  8. 8
    「アイデンティティ管理」と共にキャリアを積んだ、Okta リージョナルCSO板倉氏に聞く
  9. 9
    ガートナーやAWSの戦略に捉われるな!情シスが陥りがちな失敗する“システム起点”モダナイゼーション
  10. 10
    アクティビスト対応は経営変革のトリガー ── DNP とJ.フロントリテイリングが語るCFO組織の役割とは