テクニカルライティング中級

テクニカルライティング本 テクニカルライティング

　スタイル・ガイドを採用する

　企業や組織、大規模なオープンソースプロジェクトでは、ドキュメンテーションに既存のスタイルガイドを採用したり、独自のスタイルガイドを書いたりすることがよくあります。

スタイル・ガイドを採用するとは

文書やデザイン、情報発信に一貫性・品質・効率を持たせるために、ルールや基準（スタイルガイド）を参照・策定することが一般的であるという意味

背景と目的

  • スタイルガイド（デザインガイドラインやブランドブックなど）は、文章表現・用語・レイアウト・デザイン・ブランドのトーンなどに関するルールをまとめた文書です。
  • 既存の有名なスタイルガイド（例：GoogleのMaterial Design、AppleのHuman Interface Guidelinesなど）を参考にする場合もあれば、組織独自の事情や文化に合わせて新たに自作する場合もある。

なぜスタイルガイドを使うのか

  • 品質担保と効率化：複数人・多国籍・多拠点で作業する際も、成果物の品質や表現の統一を保ちやすくなる。
  • 共通認識の形成：ブランドの価値観やメッセージ、目指す方向性を全員で共有しやすくなる。
  • ルール継承の簡便化：人の入れ替わりや新規メンバーの参加時も、ガイドラインがあればスムーズに業務を引き継げる。

まとめ

　このように、企業やプロジェクトがドキュメンテーションにスタイルガイドを採用・作成するのは、「誰が書いても、どこで使っても、同じ品質・同じブランドイメージを保つ」ための重要な手段です

自己編集

　ある文書の初稿を書いたばかりだと想像してください。どうすればより良いものになるでしょうか？ほとんどの場合、最終的な出版文書に向けた作業は反復プロセスです。白紙のページを初稿に変えるのは、しばしば最も難しいステップです。初稿を書いたら、文書を洗練させる時間をたっぷり確保するとよい。これから上げることは、初稿を読者が必要とする情報をより明確に伝える文書に変えるのに役立ちます。大切なのは、自分に合った戦略を見つけ、その戦略をライティングの日課にすることです。

これから上げることまとめると下記になります。

  • 第一稿を書くためのいくつかの異なる戦術の中から選択し、第二稿、第三稿を書くための追加の戦術を選択する。
  • いくつかのテクニックを使って、自分の文章の間違いを見つける。
  • 大きな文書を整理する。
  • 文書の範囲と前提条件を紹介する。
  • 図のキャプションを明確に書く。
  • 技術的な図解で適切な情報密度を選ぶ。
  • 図解で読者の注意を集中させる。
  • 全体像の図解を通して、文脈を確立する
  • テクニカルイラストを効果的に修正する
  • 有用で、正確で、簡潔で、明瞭で、再利用可能で、よくコメントされた、複雑さの範囲を示すサンプルコードを作成する
  • さまざまな文書タイプを識別する
  • 何でも説明できる。
  • 初心者の読者に共感し、彼らのためのチュートリアルを書く。
テクニカルイラストとは

**テクニカルイラスト**とは、工業製品や機械、電子機器などの構造や操作方法、組み立て手順などを、専門知識のない人にも分かりやすく伝えるために描かれる技術的なイラストのことです

文書タイプを識別する

企業や組織で扱う文書には多様な種類があり、用途や内容、管理目的によって分類されます。主な文書タイプは以下の通りです。

1. 契約書類

  • 機密保持契約書、業務委託契約書、代理店契約書、賃貸借契約書、売買契約書、リース契約書など、取引や法的効力を持つ文書。

2. 社内オフィス文書

  • 管理台帳、法的申請書類、勤務台帳、業務仕様書、稟議書、作業手順書、社内報、人事データなど、社内の業務運営や情報共有に用いる文書。

3. 報告・連絡・記録文書

  • 日報・週報・月報、報告書、議事録、記録書、回覧文書、調査報告書など、業務の進捗や結果を記録・共有するための文書。

4. 指示・申請・承認文書

  • 指示書、申請書、届出書、承認書、上申書、提案書、計画書など、業務の指示や申請、承認を目的とした文書。

5. マニュアル・手順書・カタログ

  • 操作マニュアル、作業手順書、カタログ、説明書、標準化文書など、業務や製品の取り扱い方法を示す文書。

6. 図面・設計書

  • 製品や設備の設計図面、技術仕様書、技術設計書など、技術的な内容を図や文章で示す文書29。

7. 機密文書

  • 企業秘密、取引先から受け取った秘密文書、個人情報が記載された文書など、情報漏洩リスクの高い重要文書。
文書タイプの分類方法
  • ワリツケ式（トップダウン方式）：大分類→中分類→小分類のように、組織全体で体系的に分類。
  • ツミアゲ式（ボトムアップ方式）：現場で発生した文書を集約し、後から分類体系を構築。
  • ハイブリッド式：両者を組み合わせて柔軟に分類1。
まとめ

　文書タイプを識別することで、業務効率化や情報漏洩防止、検索性向上などのメリットがあります。契約書、社内文書、報告書、指示書、マニュアル、図面、機密文書など、目的や内容ごとに分類し、適切に管理することが重要です

最後に

　スタイルガイドや文書タイプなど学びました。とても学びになっています。皆様も一緒に頑張りましょう。


コメント

タイトルとURLをコピーしました