Obecna faza:
finalizacja projektu. Zobacz oś czasu.
Ta strona jest przeznaczona dla organizacji open source w fazie eksploracji procesu składania wniosku. 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 mogą znaleźć informacji konfiguracyjnych, których potrzebują, aby w sposób znaczący przyczynić się do rozwoju projektu. Niektóre procesy (np. przyczyniające się do naszych testów) nie są w ogóle udokumentowane.
Jak mierzymy skuteczność?
- Wzrost liczby nowych współtwórców
- Zwiększenie liczby nowych współtwórców niewymagających kodowania (poprzez ułatwienie współtworzenia dokumentów lub testów)
- Zmniejszenie liczby problemów zgłoszonych przez nowych współtwórców
- wzrost liczby zamkniętych zgłoszeń oznaczonych tagiem „dobry pierwszy problem”;
Jakie umiejętności powinien mieć copywriter techniczny, aby pracować nad tym projektem?
- Wymagania: znajomość GitHuba (lub chęć zapoznania się z samouczkami GitHuba)
- Dobrze mieć: znajomość naszego test runnera, aby móc uruchamiać testy i aktualizować dokumentację.
Wolontariusze
Zachęcaj członków społeczności do rejestracji, aby pomagali w wykonywaniu określonych zadań, na przykład:
- @JaneQDev, mogę pomóc w rozwiązaniu problemów z naszymi testami
- @ChenPCoder, chętnie sprawdzę prośby o przeniesienie kodu
- @ErichJEngineer, możesz przejść przez obecny proces tworzenia treści z udziałem pisarza technicznego.
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 lub życiorysu.
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
Jakich umiejętności musi mieć copywriter techniczny, aby pracować nad tym projektem?
- Opcjonalnie: znajomość technologii X.
Wolontariusze
Zachęć członków społeczności do rejestracji, aby pomogli 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. Dołącz linki do swoich prac związanych z pisaniem technicznym lub portfolio, CV lub życiorysu.
Projekt: uporządkowanie dokumentacji
Problem
- Nasza dokumentacja jest rozbudowana i nieuporządkowana. 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 mierzymy skuteczność?
- 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 powinien mieć copywriter techniczny, aby pracować nad tym projektem?
- Opcjonalnie: doświadczenie w reorganizowaniu dużych i dojrzałych zbiorów dokumentacji, znajomość SEO
Wolontariusze
Zachęcaj członków społeczności do rejestracji, aby pomagali w wykonywaniu określonych zadań, na przykład:
- @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. Dołącz linki do swoich prac związanych z pisaniem technicznym lub portfolio, CV lub życiorysu.
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 mierzymy skuteczność?
- 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ą
- świetne umiejętności organizacyjne;
Wolontariusze
Zachęć członków społeczności do rejestracji, aby pomogli w konkretnych zadaniach, na przykład:
- @ChenPCoder, możemy pomóc w organizacji wideo i czatu dla fixit oraz znaleźć wolontariuszy w innych strefach czasowych.
Informacje kontaktowe
- Jeśli jesteś copywriterem technicznym i chcesz wziąć udział w tym projekcie, wyślij e-maila na adres email@project/open lub zadaj pytanie na naszym forum. Dołącz linki do swoich tekstów technicznych lub portfolio, CV lub życiorysu.
Idea projektu: przeprowadź audyt dokumentacji
Problem
- Nie mamy pojęcia, w jakim stanie jest nasza dokumentacja. Trudno jest ustalić priorytety usprawnień dokumentacji, ponieważ nie mamy planu ani pojęcia, jakie problemy są najbardziej pilne. Mamy też dużo nieaktualnych treści, które powinny zostać usunięte lub zarchiwizowane.
Jak mierzymy skuteczność?
- tworzenie mapy drogowej dokumentacji z ogólną akceptacją 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ęcaj członków społeczności do rejestracji, aby pomagali w wykonywaniu określonych zadań, na przykład:
- @JaneQCoder, mogę pomóc w koordynowaniu prezentacji planu dokumentacji na spotkaniu społeczności
Informacje kontaktowe
- Jeśli jesteś copywriterem technicznym i chcesz wziąć udział w tym projekcie, wyślij e-maila na adres email@project/open lub zadaj pytanie na naszym forum. Dołącz linki do swoich tekstów technicznych lub portfolio, CV lub życiorysu.
Powiązane informacje
- Strona promocji i prasy zawiera logo i inne treści, których możesz używać, gdy mówisz o Google Season of Docs.
- Ten film z PyCon Australia 2017 zawiera wskazówki dotyczące porządkowania dokumentacji, aby była ona przydatna dla innych: What nobody tells you about documentation (ang. „Czego nikt Ci nie mówi o dokumentacji”) autorstwa Daniele Procid.