タグ

ドキュメントに関するonyx-pigのブックマーク (2)

  • ESDoc - ECMAScript 6に対応したJavaScriptドキュメント生成ツール

    MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました JavaScriptによるWebアプリケーション開発がどんどん大規模化しています。多人数での開発も当たり前になり、継続的に開発する中でも品質を保たなければならなくなっています。 そんな中で必要になるのがドキュメントです。今回は最新のJavaScript仕様であるECMAScript 6に対応したJavaScriptドキュメントジェネレータ、ESDocを紹介します。 ESDocの使い方 ESDocのインストールはnpmで行います。 $ npm install -g esdoc 以下はコマンドオプションです。設定ファイルのJSONか、生成するスクリプトがあるディレクトリを指定します。 $ esdoc -h usage: esdoc [-c esdoc.json | path/to/di

    ESDoc - ECMAScript 6に対応したJavaScriptドキュメント生成ツール
  • ドキュメントは最強のコミュニケーションツールである――Joelの機能仕様書入門

    ドキュメントは最強のコミュニケーションツールである――Joelの機能仕様書入門:プロジェクト成功確率向上の近道とは?(1)(1/2 ページ) ITシステム開発の問題点の一つであるコミュニケーションの失敗。連載では、これを防ぐ方法としてお勧めしたい3つのドキュメントを紹介していく。今回は「Joelの機能仕様書」のポイントを解説する。 連載目次 はじめに 連載では、ITシステム開発がビジネスに貢献していくために必要な、最も基的な条件である“システム開発の成功”につながるいくつかのポイントを紹介します。 筆者は、さまざまなコンピューターシステム開発に長年携わってきたソフトウェア技術者ですが、この連載では、あえて技術的ではない話題を中心に述べます。というのも、技術論だけではシステム開発が成功する条件としては不十分ですし、すでにたくさんの優れた技術論が各方面で展開されています。あらためてそこ

    ドキュメントは最強のコミュニケーションツールである――Joelの機能仕様書入門
  • 1