技術的負債
ドキュメントの管理方法
ドキュメント管理における技術的負債と返済方法について
現状
ドキュメントは Redmine の Wiki で管理している。
負債
- ドキュメントが適切に構造化されておらず、目的の情報にアクセスするのが困難である
- ドキュメントの管理方法が明文化されておらず、フォーマットに一貫性がなかったり、内容に過不足がある
- 「誰が」「いつ」編集したかの情報が欠けており、情報の信憑性を担保できていない
- UI/UX が著しく悪い
返済方法
- Fumadocs を用いて、ドキュメントを Markdown 形式かつファイルベースで管理する
- ドキュメントの管理方法を明文化する
利点
- AI が参照しやすいため、キャッチアップに掛かるコストを削減できる
- 編集履歴がコミットとして残るため、情報の信憑性を担保しやすい
- ファイルベースなので、他のプラットフォームに移行しやすい
- UI がモダンである