開発引き継ぎ書・READMEキット

こんなときに

システムを引き継ぎたいが、READMEは古く、鍵の置き場所も分からない

できること

コードのフォルダを読むだけで、README・引き継ぎ書・前の担当への質問リストを作ります。引き継ぎ書には構成図、定期処理の次の時刻（日本時間に直して）、外部サービス、鍵の置き場所と注意点が入ります。鍵・パスワードの値はどこにも写さず、コードのフォルダには何も書き込みません。前の担当の返事を貼ると、質問リストの番号ごとに引き継ぎ書に入り、鍵が書かれた場所や指示のような文は渡さない社内だけの点検に分けます。架空の印刷会社の見本コードで、仕組みを試すこともできます。

このキットに入っている「直し」

1. GitHub Actions の定期処理を日本時間と思い込む「定期処理は世界時刻だけ」という思い込みは古く、今は時刻帯を書ける仕様がある。書いてある時刻帯を読んで日本時間に直し、動かす機械の設定で変わるものは「分からない」と出して前の担当に聞くようにした。
2. AIの要約が時刻帯の仕様を間違って答えるWeb の要約の道具は、仕様の既定の時刻帯を取り違えて答えることがあった。仕様は要約でなく原文の該当の文で確かめ、原文どおりの扱いにしている。
3. 「毎月1日と毎週月曜」を両方に合う日と読み違える日と曜日の両方を決めた式を「両方に合う日に動く」と読むと、動く日を取り違える。crontab の仕様どおり「どちらかに合う日」で次の時刻を数え、確かめる所（△）として出すようにした。
4. 訳のファイルの単語を鍵の値と見間違える「password: Passwort」のような訳のファイルの単語を鍵の書き込みと数えると、1本で80か所を超えて誤検出した。訳のファイル・言葉だけの値・差し込みの書き方は、鍵の値として数えないようにした。
5. コードの英語のコメントをAIへの指示と取り違えるHTML のコメントやプログラムの説明の英語（skip・bypass など）を、AI への指示と取り違えることがあった。コードはコメントの印を外して中身で見て、AI を指す言葉の無い説明には当てないようにした。
6. 手元のコンテナへの接続を本番の鍵と同じ重さで数えるdocker-compose などの手元のコンテナへの接続文字列を、本番の鍵と同じ重さで数えてしまっていた。接続先が手元やコンテナの名前なら「本物か確かめる」側に分けるようにした。
7. 鍵1つずつに聞くと質問リストが34問にふくらむ鍵ごとに質問を作ると、質問リストが34問にふくらみ答えてもらいにくくなる。サービスごと・データベースごとにまとめ、管理画面の持ち主・支払い・バックアップなど「いつも聞くこと」13問を先頭に置くようにした。
8. コードの指示文が渡すREADMEにそのまま入るコードに入れた指示の文や画面を動かす札が、渡す README にそのまま入り込むことがあった。渡す物は入れてよい欄だけで作り、作ったあと鍵の値・指示のような文・社内だけの文が無いかを読み直し、あれば下書きにとどめる。

入っているもの

• 進め方（読む → メモ → 質問リスト → 答え → 渡す）
• コードを読むだけでREADMEと引き継ぎ書を作る道具
• 構成図・定期処理・外部サービス・鍵の置き場所をまとめる仕組み
• 定期処理の時刻を日本時間に直す道具（世界時刻との9時間のずれに対応）
• 前の担当への質問リストと、返事を番号ごとに取り込む道具
• 鍵が書かれた場所やAIへの指示のような文を見つける社内だけの点検
• 架空の印刷会社の見本コードで試せる機能
• 公式資料・法令にもとづく落とし穴の一覧

最初に決める3つ

1. 引き継ぐコードのフォルダ（画面に入れる）
2. 呼び名（おすすめはフォルダの名前）
3. 立場（受け取る／渡す。おすすめは受け取る）

必要なもの

• 追加費用なしClaude Code または CodexCLAUDE.md と AGENTS.md の両方を置いてあります
• 追加費用なしNode.js 18 以上道具を動かすために使います。追加で入れるものはありません
• 追加費用なし引き継ぐコードのフォルダパソコンの中にあるもの。保管箱から取ってくるのはあなたか前の担当です
• 追加費用なしブラウザ結果のページ・引き継ぎ書を見るために使います

使い方

お使いのAIに、これを貼るだけです。

nice to have のキット「開発引き継ぎ書・READMEキット」を使いたい。https://nicetohave.app/g/4WVL2QYR-•••••••••• のとおりに取り込んで。

Claude Code でも Codex でも同じです。
貼る前に、AIに何をさせるのか読む

よくある質問

実際のコードを渡さず、まず試すことはできますか？

できます。「見本で試して」と言うと、架空の印刷会社の注文受付のコードを作ってキットに通し、値を写さないこと・指示のような文に従わないことを確かめられます。

前の外注先のパスワードでログインしていいか、はっきり教えてもらえますか？

法律に当たるかどうかは言い切りません。確かめる所は「そのアカウントの持ち主から使ってよいと言われているか」の1点で、迷うときは契約の担当か弁護士に確かめるよう案内します。

鍵が1つも見つからなかったら、本当に鍵が無いと言えますか？

言えません。点検は形で拾える値だけを見るので、見つからなくても「鍵が無い」とは言わず、そのまま伝えます。

引き継ぐコードの外（上のフォルダや別プロジェクト）も読まれますか？

読みません。読むのは入れたフォルダの中だけで、ほかの場所を指すリンクはたどらず、数だけを知らせます。

プロジェクトを書類ごと消したら、コードのフォルダも消えますか？

消えません。消せるのはキットが作った書類とそのプロジェクトのメモの入力だけで、引き継ぐコードのフォルダには触りません。

応援した人

応援の受け付けを始めたら、このキットを応援した人がここに並びます。