「高専カンファレンス in 三重」でm_sekoがLTで使用するはずだった資料。

1. m_seko
� 早めに知っておきたかったドキュメント
執筆のあれこれ

2. � 目次
� はじめに
� 読者の識別
� フォーマットの把握

3. � はじめに

4. � 発表の内容
� 執筆前に行う工程の一部について、重要性と対策
例について説明する。
• 読者の識別
• フォーマットの把握
� なぜ、そんな話をするかというと
• 私が苦労したので愚痴を言いたい。

5. � このプレゼンで対象とするドキュメント
� エンジニアがドキュメントを書いて、お金を頂くこと
を前提とする
発注
納品
発注者 エンジニア

6. � 読者の識別

7. � 読者は重要
� ドキュメントのノリは読者で決まる。
読者の何がノリに 詳細
影響するか
知識レベル •説明に専門用語をどの程度使えばいいのか、ある
いはたとえ話とかを入れつつ書いた方が良いのか。
•余談だが、同業者向けドキュメントは注意。同
業者でもスキルレベルは千差万別。
与えたい印象 •テーマについて肯定的な印象を与えたいのか、否
定的な印象を与えたいのか。
•「どう受け取るかは読者に任せる」的なドキュ
メントを仕事で書くことは、ほぼ無い。
� しかし、読者を把握することは難しい…

8. � 読者の識別の対策(完璧ではないけど)
� 念のため、「誰が読むのですか？」以外の聞き方も
しておく
� 「そのドキュメントを、誰がどう使うのですか？」
• 何に使うのか分かれば、読者について追加質問する材
料にできる。

9. � 角度を変えた質問の例と追加質問の例
� 解答の例
誰が どう使うか
発注者の上司が ○○という案件を推進するために、関連する各部を
説得する材料する。
� 執筆者が追加で把握すべきことの例
把握すべきことの例
•どんな立場の方々を説得するのか。
(単純な質問では、ここがはっきりしないかもしれない)
•○○という案件について結論を出す段階なのか、まだまだ検討中なのか。
(どの程度肯定的な感じがいいのかに影響する)

10. � フォーマットの把握

11. � 絶対的なフォーマットは存在しない
� フォーマットは、コミュニティ内の文化によって決ま
る
• 文化に沿ってないと「イラっ」とされる
� 自分が属していないコミュニティの文化を知るのは
難しい
• 対策は次ページ以降

12. � フォーマットを把握するための対策
� 可能な限りコミュニティに存在する既存のドキュメ
ントを見せて貰う
• 明文化されたルールがあることもあるが、暗黙知が大事
だったりする。

13. � フォーマットを把握するには
� 既存のドキュメントを見る上で意識すること
カテゴリ 詳細
発注者が言外 •例えば発注時に「Wordで」「PowerPointで」と指定されると思う
に意図すること が、それが何を意図しているかを理解する
•例えば、「PowerPointだからプレゼン用資料」とは限らな
かったりする。
文字サイズ等 •複数のドキュメントで統一されている場合は、共通のテンプ
レートが存在する可能性があるので、そういうものが存在する
か聞いてみる。
文章構成 •「起承転結」が期待されているのか、最初に結論が期待されて
いるのか。
文体 •「ですます」調なのか、「である」調なのか。

14. � 既存のドキュメントを参照できないとき
� 他のコミュニティで参考になりそうなものを元にとり
あえず書く
• 自社のドキュメント
• 学生の時に学んだ論文のフォーマット
• 同業他社の類似するドキュメント
• 同業他社のホワイトペーパー
etc…
� レビューの時に積極的にフォーマットについて聞い
てみる。
• 結論は先の方が良いですか？とか。

15. ご静聴ありがとうございました。