ドキュメントに、嘘をつかせるな。
kizami は、ADRや設計ドキュメントをコードと並べて管理し、乖離を自動検出するミニマルなCLIツールです。
設計上の意思決定は、IssueやPR、Slackに散らばり、やがて失われてしまいがちです。 kizamiは、その意思決定をMarkdownファイルとしてコードと並べて保存します。すべての判断の理由が、コードの隣に記録され、正確に維持されます。
はじめての方へ
インストール方法やクイックスタートをお探しの方は
→ GitHubのREADME をご覧ください
ドキュメント
日常の開発での使い方や、チームでの運用方法を説明します。
| ページ | 内容 |
|---|---|
| なぜkizamiが必要か？ | kizamiが解決する問題と、その重要性 |
| 開発ワークフロー | kizamiを日常の開発プロセスに組み込む方法 |
| ADR運用ガイド | ドキュメントの書き方・粒度・ステータス管理 |
| 設定 | kizami.toml の全オプション |
| ベストプラクティス | kizamiを最大限に活用するためのヒント |
| エディタ連携 | VS Code拡張機能：サイドバーで関連ドキュメントを表示 |