エンジニアの納品の定義

納品を受領する時にリクエストするもの

1. 契約の確認

– 契約がない場合

契約はないですが、こういう形で納品してとお願いする

– 契約がある場合

事前に定義した通りに納品して貰う(先に定義しておく事が重要)

①ソースコードの納品
ソースコードのgithubへの登録
登録してもらいたいgithub repositoryを用意する

GithubのアカウントのIDを聞く

github repositoryへの招待

githubにコードを登録して貰う

②システムの納品のプロセス
ソースコードからシステムを構築する手順書を提供する
Install.md
という形のファイルにMarkdownで書いて頂ければ

含めるべき項目

[システム構成]
– WebサーバSWの種別・バージョン
– Webフレームワークの情報・バージョン
– データベースSWの種別・バージョン
– オフライン処理部分(クローラー・パーサー)
– サーバー構成
– その他ソフトウェアの情報

[サーバ構築手順書]
・それぞれ必要なサーバの構築方法
どのソフトをどの順でインストールし、どういうconfigの設定をするのか
これを
– 文章
もしくは
– 構築スクリプト(shellまたはDocker compose等)
で情報を提供する

[運用方法]
– クローラー/パーサーの稼働方法

[その他]
– 注意すべき点
– サーバ・運用費用で注意すべき事があれば

[デモ環境]
外部からアクセス出来るWebサーバを公開して下さい。
インフラは提供させて頂いたAWSの環境を好きに使って頂いて問題ないです。

③受け入れテスト
環境を手順に従って、再現出来る事をもって、受け入れとさせて頂きます。