タグ

*流し読みとドキュメントに関するrytichのブックマーク (5)

  • チェックリストはなぜ軽視されるのか!? - Qiita

    p60 「アナタなぜチェックリストを使わないのか?」 なぜ失敗してしまうのか その課題について、失敗をまとめました。 プロジェクトの失敗、リリースの失敗があったり、不祥事等この一年を通してもたくさんあったと思います。 失敗の多くは 無理 があり、 原因は「無知」「無能」の2つに分類されるそうです。 無知・・・当事者が知らなかったことによる失敗 無能・・・知っているにも関わらず正しく活用できなかったことによる失敗 現代では、ググることも出来てたり、を読んで学ぶことも出来ます。 そのため無知が問題になることより、 知識や技術を活かす タイミングを誤ったり 、 うっかりミス 、 判断を誤ったりする 無能が一番多いとされています。 (故意的に無知という体にするとか嘘の進捗を話すとかは抜いて) p17 「アナタなぜチェックリストを使わないのか?」 WHAT 失敗せずに課題解決するために、Check

    チェックリストはなぜ軽視されるのか!? - Qiita
  • わかりやすいREADME.mdを書く

    GitHubなどに自分のツールやライブラリを公開するとき,README.mdは重要な役割を担っている.レポジトリを訪れたユーザが自分のツールを使ってくれるか否かの第一歩はREADME.mdにかかっている,と言っても過言ではない.実際自分が使う側になったときも,まずREADME.mdを読んで判断していると思う. 成功しているプロジェクトを参考にしつつ,自分が実践していることをまとめておく.ここに書いていることはあくまで(自分の中で)最低限的なものである.プロジェクトが成長していくにつれてREADMEはあるべき姿に成長していくべきだと思う. READMEの役割 README.mdには大きく2つの役割がある. プロジェクト,ツールの使い方,インストール方法 プロジェクト,ツールの宣伝 元々READMEは前者の役割しかなかったが,GitHubの仕組み上,後者の役割も徐々に重要になっている. さらに

  • NTTデータ、既存システムのソースコードをもとに設計書を再生するサービス

    rytich
    rytich 2013/04/25
    "COBOL、JCL、PL/Iといった言語をサポート" ほとんど人力でカバーすることになるんじゃ
  • SEが苦手にしがちなドキュメント力を強化する5つの視点

    SEに最も必要なスキルは「伝える力」だと言われています。分業が前提となるシステム開発において、意志の伝達がうまく出来ないことは致命的だからです。 よって、作成するドキュメントにも正しく伝える技術が求められるのですが、しかし多くのSEはドキュメント作成を苦手としているようです。 そこで今日は、SEがドキュメント作成で失敗しがちなポイントと、ドキュメント力を強化するための5つの視点について、『エンジニアのための文章術再入門講座』からご紹介します。 1.SEがドキュメント作成で失敗しがちなポイント SEがドキュメント作成に失敗しがちなポイントは、主に以下の2つです。 相手の関心と不一致 知識差のための説明が不足 例えば、システム開発プロジェクトの部長向けの進捗報告の場面を思い浮かべてください。性格にもよりますが、一般に部長クラスの方が気にするのは「予算を超過しないか」「顧客との関係は良好か」「今

  • ドキュメント勉強会がアツく終了しました

    ドキュメント勉強会が無事に終了しました。 参加された皆さんお疲れ様でした。 いつもの技術系勉強会とはテーマが異なるうえ、「となりのドキュメント」のようなこれまでやったことの無い企画もあったので、始まる前は正直少し不安がありました。 しかしそんな不安が吹き飛ぶほどの盛り上がりとなり、ひとまず胸をなで下ろしています。 一参加者としては、色々なドキュメントと考え方を一度に見聞きできたのはとても面白かったです。(自画自賛っぽいですが:-D) では以下つらつらと。 ドキュメントって? shin1x1 ドキュメントに対する考えをぶちまけました:-D ドキュメントは只の技術なんで、難しく考えない。 これに気づいてからは自分はドキュメント書くのが少し楽になりました。 ご意見お待ちしていますm(_ _)m となりのドキュメント 「Poken販売サイト」をテーマに7人がドキュメントを作成して、発表するという企

  • 1