Bieżący etap:
Program Sezon na dokumenty 2021 zakończył się 14 grudnia 2021 r. Zobacz oś czasu.
Ta strona jest przeznaczona dla organizacji open source będących na fazie eksploracji procesu zgłaszania się organizacji. Te pomysły projektów to tylko przykłady, które pokazują, jak organizacje mogą opisywać możliwe projekty dokumentacji na stronie pomysłów projektów organizacji. Organizacje mogą proponować projekty, które nie są uwzględnione na tej liście.
Projekt: utwórz przewodnik dla współtwórców
Problem
- Nowi współtwórcy nie są w stanie znaleźć informacji o konfiguracji, których potrzebują, aby w sposób znaczący przyczynić się do projektu. Niektóre procesy (np. przyczynianie się do naszych testów) nie są w ogóle udokumentowane.
Jak mierzymy skuteczność?
- Wzrost liczby nowych współtwórców
- wzrost liczby nowych użytkowników niezajmujących się kodowaniem (przez ułatwienie udziału w dokumentach lub testach);
- zmniejszenie liczby problemów zgłoszonych przez nowych współtwórców;
- Wzrost liczby zamkniętych problemów oznaczonych tagiem „good first issue” (dobry problem na początek)
Jakie umiejętności powinien mieć copywriter techniczny, aby pracować nad tym projektem?
- Wymagania: znajomość GitHuba (lub chęć zapoznania się z samouczkami GitHuba)
- przydatne informacje: wiedza o tym, jak przebiega nasz test, i umiejętność aktualizowania dokumentacji,
Wolontariusze
Zachęć członków społeczności do rejestracji, aby pomóc w określonych zadaniach, na przykład:
- @JaneQDev, mogę pomóc w rozwiązaniu problemów z naszymi testami
- @ChenPCoder, chętnie sprawdzę prośby o przeniesienie dokumentów
- @ErichJEngineer, can walk through current contribution process with technical writer
Informacje kontaktowe
- Specjaliści ds. dokumentacji technicznej zainteresowani pracą nad tym projektem powinni wysłać e-maila na adres email@project. Dołącz linki do swoich prac związanych z pisaniem technicznym lub portfolio, CV.
Pomysł na projekt: napisz samouczki, aby korzystać z naszej biblioteki z ...
Problem
- Nasz projekt ma wiele problemów zgłoszonych przez użytkowników, którzy próbują korzystać z naszej biblioteki z $TechnologyX. Nie mamy jasnych wskazówek dotyczących integracji z $TechnologyX, a może to być trudne.
Jak mierzymy skuteczność?
- Zmniejszenie liczby problemów oznaczonych tagiem „$TechnologyX”
- Wzrost liczby żądań pull od nowych współtwórców, którzy pomagają nam naprawiać błędy lub uzupełniać dokumentację dotyczącą $TechnologyX
- Więcej linków do naszego projektu z projektów $TechnologyX
Jakie umiejętności powinien mieć copywriter techniczny, aby pracować nad tym projektem?
- Opcjonalnie: znajomość technologii X.
Wolontariusze
Zachęć członków społeczności do rejestracji, aby pomogli Ci w konkretnych zadaniach, na przykład:
- @JaneQDev, mogę pomóc w odpowiedzi na pytania dotyczące $TechnologyX
- @ChenPCoder, chętnie sprawdzę prośby o przeniesienie dokumentów
Informacje kontaktowe
- Specjaliści ds. dokumentacji technicznej zainteresowani pracą nad tym projektem powinni wysłać e-maila na adres email@project. Podaj linki do dokumentacji technicznej lub portfolio, CV lub CV.
Projekt: uporządkowanie dokumentacji
Problem
- Nasza dokumentacja jest obszerna i nieuporządkowane. Wielu użytkowników rezygnuje z prób znalezienia odpowiedzi w dokumentacji i zamiast tego zgłasza problemy lub zadaje pytania na naszych forach. Nasze strony nie pojawiają się w wynikach wyszukiwania nawet w przypadku odpowiednich słów kluczowych.
Jak mierzyć sukces?
- ulepszanie SEO naszej dokumentacji,
- spadek liczby problemów zgłoszonych w przypadku tematów objętych dokumentacją;
- Wzrost liczby osób, które przyczyniły się do powstania dokumentacji
Jakie umiejętności są potrzebne do pracy nad projektem?
- Dodatkowe umiejętności: doświadczenie w reorganizowaniu dużych i dopracowanych zbiorów dokumentacji, znajomość SEO
Wolontariusze
Zachęć członków społeczności do rejestracji, aby pomogli Ci w konkretnych zadaniach, na przykład:
- @ChenPCoder czeka na sprawdzenie próśb o pobranie dokumentów
Informacje kontaktowe
- Specjaliści ds. dokumentacji technicznej zainteresowani pracą nad tym projektem powinni wysłać e-maila na adres email@project. Dołącz linki do swoich tekstów technicznych lub portfolio/CV.
Projekt Idea: uruchom narzędzie do rozwiązywania problemów z dokumentacją
Problem
- Mamy wiele drobnych błędów i starych problemów związanych z naszą dokumentacją. Nasza społeczność chętnie pomoże w uporządkowaniu, ale potrzebujemy kogoś, kto zorganizuje i przeprowadzi naprawę.
Jak mierzyć sukces?
- Liczba zamkniętych problemów związanych z dokumentacją
- zwiększenie liczby osób, które przyczyniły się do powstania dokumentacji, oraz liczby nowych autorów;
Jakie umiejętności powinien mieć copywriter techniczny, aby pracować nad tym projektem?
- Opcjonalnie: doświadczenie w rozwiązywaniu problemów z dokumentacją
- Doskonałe umiejętności organizacyjne
Wolontariusze
Zachęć członków społeczności do rejestracji, aby pomogli Ci w konkretnych zadaniach, na przykład:
- @ChenPCoder pomoże Ci zorganizować film i rozmawiać na czacie oraz znaleźć wolontariuszy w innych strefach czasowych.
Informacje kontaktowe
- Pisarze techniczni zainteresowani pracą nad tym projektem powinni wysłać e-maila na adres email@project lub otworzyć zgłoszenie/zapytanie na naszym forum. Podaj linki do swoich tekstów technicznych lub portfolio, CV lub CV.
Idea projektu: przeprowadź audyt dokumentacji
Problem
- Nie mamy dobrego pojęcia o stanie naszej dokumentacji. Trudno jest ustalić priorytety usprawnień dokumentacji, ponieważ nie mamy planu ani nie wiemy, które problemy są najpilniejsze. Mamy też dużo nieaktualnych treści, które powinny zostać usunięte lub zarchiwizowane.
Jak mierzyć sukces?
- Opracowanie harmonogramu dotyczącego dokumentacji po uzyskaniu ogólnej zgody społeczności
- zmniejszenie liczby nieaktualnych lub nieprawidłowych stron dokumentacji,
Jakie umiejętności powinien mieć copywriter techniczny, aby pracować nad tym projektem?
- Opcjonalnie: doświadczenie w przeprowadzaniu audytów dokumentów
Wolontariusze
Zachęć członków społeczności do rejestracji, aby pomogli Ci w konkretnych zadaniach, na przykład:
- @JaneQCoder może pomóc w koordynacji przedstawiania harmonogramu dotyczącego dokumentacji na spotkaniu społeczności
Informacje kontaktowe
- Autorzy techniczne zainteresowani pracą nad tym projektem powinni wysłać e-maila na adres email@project/otwarcie problemu/zapytanie na naszym forum. Dołącz linki do swoich prac związanych z pisaniem technicznym lub portfolio, CV lub życiorysu.
Powiązane informacje
- Strona promocyjna i prasowa zawiera logo i inne materiały, których można użyć podczas omawiania sezonu Dokumentów Google.
- Ten film z PyCon Australia 2017 zawiera wskazówki dotyczące porządkowania dokumentacji, aby była przydatna dla innych: What nobody tells you about documentation (ang. „Czego nikt Ci nie mówi o dokumentacji”) autorstwa Daniele Procida.