ドキュメント執筆ガイド
現在準備中です このガイドは現在作成中です。完成までお待ちください。
概要
このガイドでは、River Reviewer プロジェクトのドキュメントを執筆する際の標準とベストプラクティスを提供します。
予定されている内容
今後、以下の内容を含める予定です。
スタイルと書式
- Markdownの使用規則。
- 見出しとセクションの構成。
- コードブロックの記述方法。
- リンクと参照の形式。
トーンと表現
- 技術文書における適切なトーン。
- 専門用語の使用ガイドライン。
- 日本語と英語の使い分け。
- 読者層に応じた表現の調整。
ドキュメント構成
- 各種ドキュメントタイプのテンプレート。
- セクションの推奨構成。
- 情報階層の設計。
- ナビゲーションの考慮事項。
レビューと品質管理
- ドキュメントレビューのプロセス。
- チェックリスト。
- 継続的な改善アプローチ。
暫定的な推奨事項
完全なガイドが完成するまでの間、以下の基本的な推奨事項に従ってください。
- 明確さ: 簡潔で明確な文章を心がける。
- 一貫性: 既存のドキュメントのスタイルに合わせる。
- 正確性: 技術的な内容は十分に検証する。
- アクセシビリティ: すべての読者にとって理解しやすい内容にする。
- 言語ポリシー: 日本語版（
.md）を主とし、英語版を追加する場合は同名の.en.mdを作成する。内容がずれた場合は日本語版を優先する。
貢献
このガイド自体の改善にも貢献を歓迎します。提案やフィードバックがある場合は、Issueを作成するか、Pull Requestを送信してください。
最終更新: 2025年10月26日。