AIが読むドキュメントにも、テストを書いた

AIが読むドキュメントにもテストを書くというアプローチを紹介します。コードと同様に、参照先の存在しない指示や、必要な知識が欠けている状態を防ぐために、ドキュメントの構造化とテストの重要性を説いています。

• AIが参照するドキュメントの品質を維持するため、コードと同様にドキュメントにもテストを導入するアプローチを提案している。
• ファイルサイズ制限ではなく、「AIが知識に到達できる構造」を守ることをテストの目的としている。
• 具体的には、1行の文字数制限（1000字以内）や1節の文字数制限（3000字以内）を設定し、差分管理やリンク可能性を改善している。
• 個人メモ参照（[[...]]）や相対リンク切れ、存在しないファイル参照などの「壊れ方」を防ぐための検査項目を設けている。
• Python標準ライブラリのみで構成されたスクリプトを使用し、外部パッケージに依存せず、CIでドキュメントの品質を自動検査する仕組みを構築した。