ドキュメンテーションツールの導入検討・セットアップ #147
Description
改善詳細 / Details of Improvement
- 現状、プロジェクトのドキュメントが不足しており、新規開発者や貢献者が参加しにくい状況になっている。
- 情報がIssueやコード内コメントに散らばっているため、集中管理する場所が欲しい。
そこで、情報を整理し公開するためのドキュメンテーションツールを導入する。
具体的に含めたい内容は以下の通り：
- セットアップガイド（開発環境構築）
- 利用方法（ユーザー向け）
- 貢献方法（開発者・デザイナー向け）
- よくある質問（FAQ）など
候補として Docusaurus を検討中
導入後、メンテナンスしやすいかどうかを考慮しつつ選定したい。
期待する見せ方・挙動 / Expected behavior
- GitHubリポジトリのREADMEからリンク可能で、外部の人も簡単にドキュメントへアクセス可能になる。
- Markdown形式で簡単に更新でき、Issue・プルリクエストとの連携がスムーズになる。
動作環境・ブラウザ / Environment
- 対象としている環境、バグが生じるブラウザや関係するSaaSなど