仕事で内部用文書を書くことについてのメモ

job

社内用の文書を書くことについて整理しておく。
種類としては

  • TODO
  • 技術メモ
  • 非技術メモ
  • 技術文書（仕様書・手順書）
  • 非技術文書（提案書・取説）

くらいかしら。

TODO・１行メモ

ノート・グループウェア・テキストファイルなど、あちこちに分散してしまう。
最近は量が溜まると*1Wikiに整理するようにしている。

技術メモ

目的は主に２つ。

  • 自分用のメモ。
    • Wikiに書くと探しやすいので便利。
    • また、「書くことが楽しくなる」Wikiの仕組みは仕事の効率化に役立つ。
    • 過剰な装飾がない・できない点も効率化のポイント。
  • 同僚・部下に仕事を振るための道具。
    • メモの目的を先頭に明示する。
    • 仕事振り用なら、要点は漏らさず書く。難解な部分は詳細（実装）を漏らさず書く。

非技術メモ

仕事の回し方に関するものがほとんど。
人に見せるために書くこともあれば、人に見せたくないものを符丁で書いたりもする。詳細な部分でも、重要だと思えば迷う前に書く。

技術文書

人に読まれる文書。丁寧に、抜けなく、平易な表現で書く必要がある。新人が調べながら読み通せる程度。
しかし分量が多すぎるのはよくない。読まれないからではなく、保守作業が大変となるため。また同じ理由で図版が多すぎてもいけない。

非技術文書

取扱説明書は、市販製品のそれを参考に。ただし丁寧に書きすぎないよう注意。社内用であればWikiで済ませたいところ。

提案書（プレゼン資料）は、

  • 価値が必要な場合と、
  • 無難な内容が求められる場合

がある。案件に対する自分のロールをよく把握してから作成すること。



というわけで。
さぁ、来週からばりばり文書を書くぞー。

*1:そもそもTODOを溜めてはいけないのだけど