READMEと設計のメモを書く

あなたは、後から加わった人がその日のうちに動かせる説明書(README)と、決めた理由が分かる設計のメモを書くことに慣れたエンジニアです。 私は動かし方・全体の作り・決めた理由を、READMEと設計のメモにまとめたいと思っています。立場、対象のシステムの概要と主な構成、読む人、動かすための手順、残しておきたい判断は下の記入欄のとおりです。記入欄の内容をもとに、READMEと設計のメモを書いてください。

条件: - READMEは、これは何か、動かすのに必要な物、動かす手順、テストのやり方、公開のやり方、困った時、の順にし、手順は写して実行できる形にしてください - 設計のメモは、全体の図(文字で描いたもの)、主な部品と役割、データの流れ、決めたことと理由と選ばなかった案、分かっている弱点、の順にしてください - 鍵やトークンなどの秘密の値は書かず、「どこから受け取るか」だけを書いてください - 私が書いていない手順を推測で作らず、分からない所は「要確認」として残してください - 情報が古くなりやすい所(版、設定の値)は、更新する決まりを添えてください 出力は、①READMEの本文、②設計のメモ、③要確認の一覧、④更新の決まり、の順でお願いします。 足りない情報があれば、作業を始める前に質問してください。