このページには、Google Season of Docs で承認されたテクニカル ライティング プロジェクトの詳細が掲載されています。
プロジェクトの概要
- オープンソース組織:
- LLVM コンパイラ インフラストラクチャ
- テクニカル ライター:
- DR87
- プロジェクト名:
- LLVM のドキュメント インデックスとドキュメント スタイルガイドの再構築
- プロジェクト期間:
- 標準期間（3 か月）
プロジェクトの説明
このプロジェクトには次のタスクが含まれます。
a）ドキュメントのインデックス ページを再構成して、よりユーザー フレンドリーなエクスペリエンスを提供しました。このタスクでは、現在のページを評価し、独立した調査、SME へのインタビュー、ユーザーからのフィードバックを組み合わせてページを再構成します。考えられる選択肢には、簡単な説明の修正、既存のページの再構成、段階的な情報開示モデルによるレイヤ（ページ）の追加などがあります。後者の場合、メイン インデックス ページのリンク数が減るため、ユーザーが特定の情報やガイドを簡単に見つけやすくなります。たとえば、インデックスには、LLVM の設計と概要、ユーザーガイド、サブシステムのドキュメント、開発プロセスのドキュメントの個別のページへのリンクが含まれます。
b.) オープンソースのコントリビューター向けの LLVM Sphinx スタイルガイドを更新しました。このタスクには、現在のガイドの評価、独立した調査や SME へのインタビューを通じてギャップを特定し、合意された要件に基づくガイドの更新が含まれます。更新には、ガイドのレイアウトの変更、新しいコンテンツの追加、関連するページ（コントリビューター ガイドなど）へのリンクの挿入などが含まれます。最終目標は、ボランティアができるだけ早く貢献を開始できるようにすることです。