Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source
- INCF
- Pisarz techniczny:
- Ogbonoko
- Nazwa projektu:
- The Turing Way: A How-to Guide to Data Science
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Wprowadzenie
Rosnąca popularność nauki o danych i wszechstronność jej zastosowań sprawia, że jest to atrakcyjna dziedzina dla studentów, badaczy, ekspertów z branży i specjalistów z różnych dziedzin i poziomów wiedzy. Aby wspierać rozwój w tej dziedzinie, niezwykle ważne jest, aby badania w zakresie analizy danych były i pozostawały dostępne dla szerszej społeczności pasjonatów tej dziedziny. Jednym ze sposobów na osiągnięcie tego celu jest udostępnienie przewodników dotyczących przeprowadzania powtarzalnych, wielokrotnego użytku i opartych na współpracy badań z zakresu Data Science.
Jednym z takich przewodników jest The Turing Way, którego misją jest „zapewnienie możliwości przeprowadzania badań z możliwością odtworzenia wyników”. Obecnie The Turing Way zawiera treści dotyczące badań z możliwością odtworzenia wyników, projektowania projektów, komunikacji, współpracy i badania etycznego. Jednak wraz z rozszerzaniem zakresu The Turing Way potrzebna będzie pomoc redakcyjna, aby włączyć nowo utworzone treści do dotychczasowego zbioru.
Cele projektu
Ogólnie rzecz biorąc, moim zadaniem jako autora technicznego w tym projekcie jest ułatwienie dostępu do The Turing Way społeczności nauki o danych poprzez:
sprawdzenie dotychczasowych rozdziałów książki The Turing Way pod kątem możliwości ulepszenia języka i struktury;
włączanie nowych treści do istniejącego zbioru prac przy jednoczesnym zachowaniu ogólnego stylu i tonu The Turing Way;
dodawać nowe treści w postaci nowych rozdziałów, interaktywnych samouczków lub studiów przypadków.
Oś czasu
Jeśli zgłoszenie zostanie rozpatrzone pozytywnie, proponuję ukończenie projektu w następujący sposób:
Do 17 sierpnia:
W miarę możliwości wnieś swój wkład w proces Turinga (poprawianie literówek itp.).
zapoznać się z aktualnymi informacjami zawartymi w The Turing Way;
Ulepszyć swoje umiejętności pisarskie i redaktorskie oraz nauczyć się obsługi narzędzi, z których będę korzystać.
Etap budowania więzi z lokalną społecznością (17 sierpnia – 23 września):
aktywnie współpracować z zespołem lub społecznością stojącą za The Turing Way i dowiadywać się więcej o projekcie;
Utwórz i utrzymuj kanały komunikacji z mentorami.
Dopracowuj i ostatecznie ustal cele projektu z uwzględnieniem opinii mentorów i całej społeczności.
Tydzień 1 (14–19 września)
Pierwszy tydzień poświęcę na prawidłowe skonfigurowanie niezbędnych narzędzi, aby zapewnić sobie produktywność.
Ponadto podczas czytania książki The Turing Way odkryłem kilka literówek. Zamierzam jednak poprawić te błędy przed 17 sierpnia, ponieważ pracuję nad tym projektem. Proponuję, aby przez pierwsze kilka tygodni zajmować się istniejącymi już rozdziałami książki i zadbać o to, aby gramatyka, pisownia i ton były poprawne, spójne i atrakcyjne dla docelowych odbiorców projektu.
Zaczynam korektę od rozdziału zatytułowanego „Przewodnik po powtarzalnych badaniach”.
Tydzień 2 (20–26 września)
Sprawdź i edytuj rozdział Przewodnik po projektowaniu projektów oraz wszelkie nowe treści publikowane w witrynie. W razie potrzeby zaproponuj niezbędne zmiany.
Tydzień 3 (27 września – 3 października)
Sprawdź i edytuj rozdział zatytułowany „Przewodnik po komunikacji”.
Tydzień 4 (4–10 października)
Sprawdź i edytuj rozdział Przewodnik po współpracy i wprowadzaj nowe treści.
Tydzień 5 (11–17 października)
Przeczytaj i edytuj rozdział zatytułowany „Przewodnik po etycznym prowadzeniu badań” oraz wszelkie nowe treści.
Tydzień 6 (18–24 października)
Przeczytaj i zmodyfikuj rozdział zatytułowany Przewodnik po projektowaniu projektu oraz wszelkie nowe treści.
Tydzień 7 (25–31 października)
twórz nowe treści dla The Turing Way z pomocą mentorów projektu. Nowe treści mogą mieć postać nowego rozdziału, samouczka lub przykładu. Na przykład w ramach swojej pracy doktorskiej pracuję obecnie nad opracowaniem metod wyszukiwania i interpretacji podcastów. Mogę udokumentować to doświadczenie i swoje wyniki w ramach przypadku.
Tygodnie 8–10 (1–28 listopada)
Uzupełnij dokumentację dotyczącą treści z 7. tygodnia, jednocześnie sprawdzając pod kątem błędów nowe treści stworzone przez innych.
Tydzień 12 (29 listopada – 5 grudnia)
Zadbaj o poprawność tekstów, aby zapewnić ich zgodność z faktami, dokładnością i spójnością. Będę też dokumentować i przesyłać swoje przemyślenia na temat sukcesu projektu oraz ocenę moich mentorów.