タグ

documentationに関するnobusueのブックマーク (7)

  • 勘違い?小規模プロジェクトにドキュメントは不要か(前編)

    この道20年選手になろうとしているプロジェクトマネジャー(プロマネ、PM)の宇佐木さん。ウェブシステムを作る小さいIT会社に勤めており、現在は○○植物園、××博物館、△△商店街の三つのプロジェクトを抱えています。 20代の頃にこの会社に転職して以来、多くのプロジェクトを担当してきました。ですが、このところトラブルが続いているようです。 システムエンジニア(SE)虎岡:ウサさん、この間頼まれた○○植物園のアクセスログの一覧できたけど、ものすごく時間がかかったよ。このシステムを実装したのって、外注先の荒川さん(プログラマー)だと思うけど、資料が何もないんだよ。アクセスログがどこにあるか分からないし、何というファイル名かも……。とにかく出しておいたから、あとはよろしく。 宇佐木:ごめんごめん。荒川さんにはいつも言ってるんだけど。なかなかドキュメント書いてくれないんだよ。 SE虎岡:ちゃんと伝わっ

    勘違い?小規模プロジェクトにドキュメントは不要か(前編)
    nobusue
    nobusue 2016/09/26
    小規模ならMarkdown、大規模ならAsciiDocあたりがよい
  • 仕事を成功させる思考術(21)「説明の辻つまが合っていない仕事」はダメである

    この連載では、「仕事を成功させるための思考術」を扱っている。前回まで5回にわたって、「資料」をテーマにB社の浮島氏と上野氏、彼らのメンターである東氏のケースで説明した。「失敗をもたらす10のダメ仕事」は次の通りである。 (1)目的が曖昧で作業手順がいい加減な仕事 (2)情報が不足し鮮度も悪い仕事 (3)他人をないがしろにする仕事 (4)素人の浅知恵で判断する仕事 (5)発想が貧困でつまらない仕事 (6)自分の考えに酔いしれる仕事 (7)社内調整が甘い仕事 (8)資料が非論理的で分からない仕事 (9)説明の辻つまが合っていない仕事 (10)思想も志も見えてこない仕事 前回は、東氏の問いに対して、必死に答えを探そうとする上野氏の状況を紹介した。東氏から渡された膨大な著作データの中から、浮島氏の過去に関するメモと「人のメディア力」に関する執筆を読んだ上野氏が、何かをつかんで会社に向かうところで終

  • 外資系コンサルが用いる「資料作成」という技術

    ビジネスの現場では、さまざまな資料を作る機会がある。報告書や提案書、会議の議事録に発表資料など、仕事の内容や状況によって形は変わるが、すべからく「ビジネス文書」であり「資料」だ。 「資料なんて、そんなものにこだわる必要はない」「資料作りに時間を割くのはばからしい」――。その意見には、筆者も賛成だ。不必要に凝ったものを作る意味はない。要は中身が正しく伝わればいいのだ。PowerPointExcel、Wordを駆使して凝った資料を作っても、中身がなければ話にならない。そもそも、資料を作っただけで仕事が終わるなんてことは、普通ない。 ただ、それは「資料作りが不要」という話ではない。資料作りに過剰な時間をかけるのは無駄だけれど、かといって「伝わらない資料」を作ってしまっては、さらに時間の無駄だ。ましてや、その時間は自分のものだけではない。その資料を読む相手の時間も無駄に消費することになる。 体系

    外資系コンサルが用いる「資料作成」という技術
  • 文章が苦手な人にもできる文書力を上げる10の方法 | 株式会社LIG(リグ)|DX支援・システム開発・Web制作

    こんにちは、LIGブログ編集長の朽木です。世の中には“わかりやすい人間”と“わかりにくい人間”がいて、概してわかりやすい人間の方がよくモテ、出世もしやすく、幸せな人生を送れると思う今日この頃です。 わかりにくい人間であるところの僕は、せめて自分の書く文章くらいはわかりやすくしたいと思っておりますが、みなさまの文章のわかりやすさはいかがでしょうか。 文章を書くことは、なにもライターや編集者だけの仕事ではありません。社内の報告書、社外へのビジネスメールなど、コミュニケーション・ツールとしての文章は、どんなに技術が進歩してもなくならないものです。 “他人が読むこと”を前提とするにあたり、目的は相手に情報を伝えること、であれば大切なのはその文章がわかりやすいかどうかになるでしょう。 僕は、月に100くらいの原稿をチェックします。まだまだ勉強中の身ではありますが、そんな生活を続けていると、少なくと

    文章が苦手な人にもできる文書力を上げる10の方法 | 株式会社LIG(リグ)|DX支援・システム開発・Web制作
  • 技術ドキュメント改善作戦 TDI-#1� �Apache 設定ファイル(1)

    Apache の設定ファイルの説明文を題材に、文章だけの技術マニュアルをどうわかりやすく図解するか、というテーマで、思考プロセスを1ステップずつたどって考えられるように練習問題形式で解説しました。 (1月18日追記)作成途中だった後半を追記しました。Read less

    技術ドキュメント改善作戦 TDI-#1� �Apache 設定ファイル(1)
  • 文章を「書ける人」と「書けない人」のちがい

    文章を書くという仕事は、ゼロを1にする作業だと思われがちだ。小説や脚ゲームシナリオなどの創造的な文章ならばなおさらだ。しかし実際には、文章を書くというのは100を1にする作業だ。文章を書けるかどうかは、このことに気づけるかどうかだと思う。

    文章を「書ける人」と「書けない人」のちがい
  • 第2回 問題を説明できない~「トラブル報告力欠乏症」

    連載では、ビジネス文章力を向上させたい方のために、筆者がこれまで実務の現場で部下や後輩に教えてきたケースを紹介しながら、さまざまな文章スキル不足を「病」にたとえ、それを治療するというコンセプトで、スキルアップの具体的方法について解説します。 第2回の治療は「トラブル報告力欠乏症」の治療です。仕事をやっていれば、大小いろいろな問題が発生します。このような緊急時に、上司、上長や関係者に適切な説明ができないと「ダメ」と評価され、重度仕事力欠如疾患となってしまいます。今日の患者さんは、そんな状況だったのです。 ◆岡田ケイ子さん(仮名 23歳女性)の症状◆ 芦屋:では次の方、岡田ケイ子さんですね。今日はどうされましたか。 岡田:はい、私は入社して1年ちょっとなんですが、いつも仕事でトラブルが発生すると憂になるんです。文章が下手で、上司がいつも怒ってしまいます。上長も冷たいし、顧客からも冷たい態度

    第2回 問題を説明できない~「トラブル報告力欠乏症」
  • 1