タグ

関連タグで絞り込む (1)

タグの絞り込みを解除

documentationに関するkdmsnrのブックマーク (3)

  • 高品質なフリー・ドキュメントの作成を目指すFLOSS Manuals | OSDN Magazine

    フリー/リブレ/オープンソース・ソフトウェア(FLOSS)の弱点の1つに挙げられるのがドキュメントだ。そんな状況の改善を目指しているのが、FLOSS Manualsというプロジェクトである。フリーソフトウェア向けに、高品質なフリーのドキュメントを作成することを目的としたプロジェクトだ。 FLOSS Manualsを立ち上げたのは、デジタル・アーティストのAdam Hyde氏だ。一般的なFOSS貢献者に比べると、同氏の経歴は一風変わっている。ニュージーランドで独立系のラジオ局を開設したり、オーストラリアとオランダでインターネット・サービス・プロバイダを運営したりなど、さまざまな事業を手がけてきた人物だ。 だが、FLOSS Manualsが誕生した背景は、一般的なオープンソース・プロジェクトと変わらない。すなわち、何らかの欲求や要求を満たすために始められたプロジェクトである。フリー/オープンソ

    高品質なフリー・ドキュメントの作成を目指すFLOSS Manuals | OSDN Magazine
  • SEは美しいドキュメントを作れ

    SEは仕事上,開発計画書,提案書,システムの鳥瞰図や概要図,業務フロー,業務分担図などさまざまな資料を作る。打合わせ資料,進捗報告書やトラブル報告書などの類もある。そしてそれをお客様に提示する。そんな時,お客様から「この資料は良くまとまっているね」,「この図は上手いですね」,「凄く分りやすいです」などと言っていただけるといろいろなメリットがある。 ドキュメントは強力なコミュニケーション・ツール まず,お客様に「このSEはやるな!」と思っていただける。すると信頼を得やすい。新規顧客だとその瞬間に自分を売り込める。その効果は絶大である。 次に,顧客に自分が言いたいこと,訴えたいことをより的確に伝えることができる。すると顧客との間での,勘違いや早とちりなどの誤解が大幅に減る。システムの開発範囲や要件の範囲などの打合わせでは,その効果は少なくない。 即ち,ドキュメント力はSEにとっては強力なコミュ

    SEは美しいドキュメントを作れ
    kdmsnr
    kdmsnr 2007/01/31
    その美しいドキュメントやらを見せて欲しいものだが
  • Natural Docs

    Natural Docs lets you document code written in any of 21 programming languages, plus it can be easily extended for more so whatever you use, it can too.  And if your project uses multiple languages, no problemIt will all be included in the same set of documentation. Natural Docs also speaks your other language... English!  Its comments are designed to be very natural and readable so they're jus

  • 1