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