自分の README を証拠として使わない

状況

掲載する作品の説明を書き始めたとき、各リポジトリの README には、暗号化やデータベース側の実装のような、確かめずに書き写せてしまう主張が並んでいた。どれも自分で書いた説明だった。

選択肢

• README が謳っている主張をそのまま作品説明に載せる却下
• 主張ごとにコードを追って裏を取り、裏が取れないものは撤回する採用

選んだもの

主張ごとにデータの通り道を追い、実装に無かったものは掲載前に取り下げた。

却下した理由

README が謳っている主張をそのまま作品説明に載せる

調べた作品では、README が中核として謳っている機能が実装に存在しなかった。そのまま載せることは、確かめていない主張を自分の実績として掲げることになる。

後で分かったこと

取り下げた主張には共通の形があった。どれも「動くと思っていたものが動かなかった」ではなく、書いた説明が実装より先へ進んでいた、というものだった。暗号化を掲げたトンネルは、共有コードの並びに公開鍵の欄すら無く、配線すれば動く状態ですらなかった。日次の上限をデータベースのビューで実装したと書いたものは、そのビューがアプリケーションから一度も参照されていなかった。使った手立ては、文字列検索でデータの通り道を追うことと、構造体の定義と実装そのものを読むことだけで、特別な道具は要らなかった。¹