絞り込み条件を変更する
検索条件を絞り込む
有料ブログの投稿方法はこちら

すべてのカテゴリ

8 件中 1 - 8 件表示
カバー画像

システム開発のドキュメンテーション

 システム開発には、ココナラで受注するものから、チームで進めるものまで、様々な規模がありますが、ドキュメンテーション(ドキュメント作成)がつきものです。 このブログ記事では、私が考える ドキュメント作成にかけるべき時間(工数)について、特に ココナラで受注するような小規模案件のドキュメンテーションをご紹介したいと思います。`````````````````````````````` 私は、小規模案件であれば、ドキュメンテーションに費やす時間は 全体の5%程度がちょうどいいと考えています。(※注:15分程度でサクッと終わる場合は除きます) 数日〜1週間程度のプログラム作成の場合でも、受注前に全体の青写真を描くと、発注者様も安心するし、受注者側としても 手戻りのムダが大幅に減るのです。 通常 私は、作業時間を6時間/日で見積もります。正味作業で2日間程度の作業ならば、ドキュメント作成にかける時間は せいぜい30分程度でしょうかね。こんな感じです。 私の愛用ソフトは Microsoft Visio 2019。これくらいのブロック図であれば、なれると 30分くらいでサクッと書くことができます。  私はこの作業を、受注前に行うようにしています。お互いに安心できるお取引が出来ると、気分がいいですよね。
0
カバー画像

ドキュメントをいつかくか?

ドキュメントをいつかくか?プログラム開発でドキュメントが必要なのは既にいくつかの記事で書いてきました。この記事では、いつドキュメントを書くのが良いのかを考えてみました。ドキュメントは後回しになりがち!会社などでの開発は、開発の「プロセス」があるので、ドキュメントを作成するタイミングは基本的に決まっています。 特に、複数の人で開発する場合は、ドキュメントを基にした開発というのが基本なので、ドキュメントは、実際にコーディングに着手する前に作成するのが普通です。ところが、フリーランスでプログラムを開発する場合、一人で開発する場合が殆どなのでドキュメントが無くてもコーディング上はドキュメントが無くても進めることは可能なので、ドキュメントの作成は後回しになる場合が多いようです。仕事の中心がコーディングだと考えている場合も多くドキュメントの作成はどうしても二番目以降になってしまいます。会社では、何故ドキュメントを先に作るのか?では、会社ではなぜ最初にドキュメントを作成するのかを考えてみましょう。 幾つか理由がありますが、ここでは二つの大きな理由をあげてみました。全体の設計と仕事の割り当てをするため各モジュールのインターフェースの明確な定義当たり前ですが、全体の設計をしないと仕事の割り当てができません。会社では多くの人が一つの大きな開発に参加するのが普通です。そのために、まずは全体の設計をして、どのよう仕事の分担を決めます。また、全体の機能が明確になるので、テストの計画の開発もプログラムの開発と同時に進める事ができます。また、各モジュールの設計をするのに必要なインターフェースを明確にして、モ
0
カバー画像

プログラムの詳細のドキュメントは必要か?

プログラムの詳細のドキュメントは必要か?プログラムを開発する場合、ドキュメントが必要なのは言うまでもありません。プログラムの中身をどのように作るかを詳しく書いたドキュメントいわゆる、設計仕様書は必要でしょうか?この記事では設計仕様書の考え方についてまとめてみました。プログラムの設計仕様書とは?最初に、プログラムの設計仕様書とは何かをハッキリさせておきましょう。 これは、プログラムを「どのように作るか(作ったか)」を各ドキュメントです。 プログラムは将来的にも不具合の修正や機能拡張などで、手を入れることも多く、実際にコーディングをした設計者でもその中身の詳細を覚えていることは難しくなります。多くの場合は、最初のコーディングをした人と別の人がプログラムに手を入れる事も多いので、プログラムがどのように作られているかを書いたドキュメントがないと、コードを読みながら理解して修正する事になるので効率が悪くなります。従って、きちんと設計仕様のドキュメントを残すことはとても重要です。操作の説明(取り扱い)のドキュメントは、利用者のためのドキュメントですが、設計仕様書の場合は、プログラマーのためのドキュメントという事になります。従って、内容は専門的で問題ありませんが、プログラムがどのように作られているかを分かりやすく書く必要があります。操作の説明と詳しい設計仕様はどっちが大切?会社などでプログラムを開発する場合は、操作の説明のドキュメントも、設計の仕様書も両方きちんと作ることが求められます。当然と言えば当然ですが、フリーランスの場合は、短期間での開発を求められる場合も多く、時間との兼ね合いで両方
0
カバー画像

プログラムのドキュメントの書き方

プログラムのドキュメントの書き方プログラミングを仕事として行う場合、プログラミングのドキュメントは必須の物の一つです。趣味でプログラムを作るのとは違って、いろいろな人が作成するプログラムに関わってきます。作成するプログラムがどんな物なのかをプログラムを作った人以外の人が理解するのにドキュメントは重要です。どんなドキュメントが必要か?会社などでプログラムを開発する場合、沢山のドキュメントが作成されます。 基本的に、割り当てられた仕事毎に幾つか必要なドキュメントがあります。殆どの仕事には、「入力(インプット)」と「出力(アウトプット)」があります。 その仕事を進めるために必要な情報が「入力(インプット)」で、仕事の結果(成果)が「出力(アウトプット)」になります。プログラムを作る場合の入力は、「どんな機能が必要か」が入力(インプット)になります。この入力の情報に基づいて「どんなプログラム」を作るかが、プログラムを設計する人の出力(アウトプット)になります。多くの場合、仕事と仕事を繋げる役割をするのが、ドキュメントになります。従って、一つのプログラムの開発プロジェクトの場合でも、沢山のドキュメントが必要になります。* 利用者の要望、意見、フィードバックをまとめたもの* 実際のプログラムの要求をまとめた物* 実際のプログラムで実現する機能や方法(やり方)をまとめたもの* プログラムの使い方をまとめた物* プログラムのテストの方針をまとめた物(テストプラン)* プログラムのテスト結果をまとめた物(テストレポート)など基本的なものだけでも結構な数になります。当然ですが、作成するドキュメント
0
カバー画像

プログラムのテストプランの作り方

プログラムのテストプランの作り方プログラムの品質を確保(検証)するのにテストは欠かせません。しかし、フリーランスで開発をする場合は、専門のテストスタップがいない場合も多く、一般的な企業で開発する場合よりテストも限られたものになる場合が多くなります。この記事では、最低限のテストプランをどのように作成したら良いのかをまとめてみました。大切なドキュメント当たり前ですが、どんな場合でもプログラムがサポートする基本機能の確認は必須です。基本機能が動かないというのは、大きな問題です。従って、どんなに時間と人手が限られていても、基本機能の確認のテストは絶対に必要です。ところで、会社などでテストの専門チームがテストの計画を作る場合、どのように作るかご存知ですか?通常は、プログラムのドキュメントを基に作成します。実はこのドキュメントが無いとテストを考えるのは難しくなるのと、テストを行うのも難しくなります。プログラムを開発する場合、求められる機能があるのが普通です。これらの要求事項を満たすようにプログラムを開発します。ところが、その機能を利用する場合、どのような手順でプログラムを使えば良いかは、プログラムをどのように実現するかで変わってきます。プログラムの開発者は、最低でも2種類のドキュメントを作るのが基本です。* プログラムをどのように作ったか(プログラムの仕様書)* プログラムをどのように使うか(操作マニュアル) プログラムをどのように作ったかをきちんとドキュメントに残しておくと、将来の保守やトラブル時にプログラムを見直す場合などに役に立ちます。きちんとドキュメントを残すことが重要です。作成し
0
カバー画像

岩肌に刻まれた謎の梵字群を観察する為に歩く【バーチャル散歩】

0
カバー画像

溶岩の上に作られた遊歩道を歩く【バーチャル散歩】

0
カバー画像

【バーチャル散歩】江戸時代に100年かけて作られた石畳の街道を歩く

0
8 件中 1 - 8
有料ブログの投稿方法はこちら