このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- INCF
- テクニカル ライター:
- Ogbonoko
- プロジェクト名:
- The Turing Way: A How-to Guide to Data Science
- プロジェクトの長さ:
- 標準の期間（3 か月）
プロジェクトの説明
はじめに
データ サイエンスの人気が高まり、そのアプリケーションの汎用性が高まることで、データ サイエンスは、さまざまな分野と専門知識レベルの学生、研究者、業界の専門家、専門家にとって魅力的な分野となっています。この分野の成長を促すには、データ サイエンス研究が、データ サイエンス愛好家の幅広いコミュニティにアクセス可能であり続けることが不可欠です。この目標を達成する 1 つの方法は、再現可能で再利用可能でコラボレーション可能なデータ サイエンス研究を行うためのガイドを提供することです。
Turing Way はそうした指針の一つであり、「再現可能なデータ サイエンスは『容易にはやらない』ことを目指すものです。現在 Turing Way には、再現可能な研究、プロジェクト設計、コミュニケーション、コラボレーション、倫理調査に関するコンテンツが含まれています。ただし、チューリング ウェイの範囲が拡大するにつれ、新たに作成されたコンテンツを既存の作品に組み込むには編集サポートが必要になります。
プロジェクトの目標
このプロジェクトのテクニカル ライターとしての私の仕事は、次のようにして、データ サイエンス コミュニティが Turing Way をより簡単に利用できるようにすることです。
The Turing Way の既存の章を見直し、文章と構成を改善する方法を探る
The Turing Way の全体的なスタイルとトーンを維持しながら、既存のコンテンツに新しいコンテンツを組み込むこと。
新しい章、インタラクティブなチュートリアル、ケーススタディなどの新しいコンテンツを提供する。
タイムライン
申請が承認された場合は、次の方法でプロジェクトを完了することを提案します。
8 月 17 日までに:
可能であれば Turing Way に貢献する（誤字脱字の修正など）
The Turing Way に記載されている最新情報を把握する
使用するであろうツールをすぐに使いこなしながら、ライティングと編集のスキルを向上させることができる。
コミュニティ ボンディング フェーズ（8 月 17 日～ 9 月 23 日）:
The Turing Way のチームやコミュニティと積極的に交流し、プロジェクトについて学びましょう。
メンターとのコミュニケーション チャネルを確立し、維持する。
メンターやコミュニティ全体からのフィードバックに基づいて、プロジェクトの目標を絞り込み、確定します。
1 週目（9 月 14 日～ 9 月 19 日）
最初の 1 週間は、生産性の確保に必要なツールを適切にセットアップすることに費やされます。
さらに、「The Turing Way」を読んでいるときに、いくつかの誤字を見つけました。ただし、プロジェクトに貢献する立場として、8 月 17 日までにこれらのエラーを修正する予定です。最初の数週間は、書籍の既存の章を確認して、文法、スペル、トーンなどが正しく、一貫しており、プロジェクトのターゲット ユーザーに魅力的であることを確認することをおすすめします。
まず、校正の段階を「再現性のある調査のガイド」という章から始めます。
2 週目（9 月 20 日～ 9 月 26 日）
「プロジェクト設計ガイド」というタイトルの章と、新しいコンテンツの投稿を校正し、編集し、必要に応じて変更を提案します。
第 3 週（9 月 27 日～ 10 月 3 日）
「コミュニケーション ガイド」というタイトルの章を校正して編集します。
第 4 週（10 月 4 日～ 10 月 10 日）
「コラボレーション ガイド」というタイトルの章の校正と編集を行い、新しいコンテンツの投稿を行いました。
第 5 週（10 月 11 日～ 10 月 17 日）
「倫理的な研究のガイド」というタイトルの章と、新しいコンテンツの投稿を校正して編集します。
第 6 週（10 月 18 日～ 10 月 24 日）
「プロジェクト設計ガイド」というタイトルの章や新たに投稿するコンテンツについて、校正と編集を行います。
第 7 週（10 月 25 日～ 10 月 31 日）
プロジェクトのメンターの意見を取り入れて、『The Turing Way』の新しいコンテンツのブレインストーミングを行い、制作する。この新しいコンテンツは、新しい章、チュートリアル、ケーススタディの形で提供されます。たとえば、現在私は、論文の一部として、ポッドキャストの取得と理解のための方法の開発に取り組んでいます。この経験と学習成果をケーススタディとして記録できます。
第 8 ～ 10 週（11 月 1 日～ 11 月 28 日）
他のユーザーが作成した新しいコンテンツの校正を行いながら、7 週目の内容のドキュメントを完成させます。
第 12 週（11 月 29 日～ 12 月 5 日）
記述されたコンテンツをファインチューニングして、事実性、正確性、一貫性を確保します。また、プロジェクトの成功に関する反省とメンターの評価を文書化して提出します。