Obecny etap:
opracowywanie dokumentacji. Sprawdź oś czasu.
Ta strona jest przeznaczona dla organizacji open source, które znajdują się na fazie eksploracji procesu aplikacji. Te pomysły projektów są tylko przykładami, które pokazują, jak organizacje mogą opisywać możliwe projekty związane z dokumentacją na stronie pomysłów na projekty organizacji. Organizacje mogą zgłaszać projekty, których nie ma na tej liście.
Pomysł na projekt: utwórz przewodnik wprowadzający dla współtwórców
Problem
- Nowi współtwórcy nie mogą znaleźć informacji konfiguracyjnych, których potrzebują, aby wnieść znaczący wkład w nasz projekt. Niektóre procesy (np. udział w testach) w ogóle nie są udokumentowane.
Jak możemy mierzyć skuteczność?
- wzrost liczby nowych współtwórców,
- Wzrost liczby nowych współtwórców niewymagających umiejętności kodowania (przez ułatwienie dodawania treści do dokumentów i testów)
- Zmniejszenie liczby problemów zgłoszonych przez nowych współtwórców
- Wzrost liczby zamkniętych zgłoszeń oznaczonych etykietą „Pierwszy problem”
Jakich umiejętności potrzebuje pisarz techniczny, aby pracować nad tym projektem?
- Wymagane: Znajomość serwisu GitHub (lub gotowość do korzystania z samouczków dostępnych w serwisie GitHub)
- Warto mieć: znajomość programu wykonującego testy i zaktualizowanie jego dokumentacji.
Wolontariusze
Zachęć członków społeczności, by zarejestrowali się, aby pomóc im w określonych zadaniach. Na przykład:
- @JaneQDev: możesz mi pomóc w odpowiadaniu na pytania dotyczące testów
- @ChenPCoder, z przyjemnością zapoznam się z prośbami o przesłanie dokumentów
- @ErichJEngineer, może omówić bieżący proces przesyłania treści z pomocą autora technicznego
Informacje kontaktowe
- Autorzy techniczni zainteresowani pracą nad tym projektem powinni wysłać e-maila na adres email@project. Dołącz linki do swoich prac technicznych lub portfolio/życiorysów/CV.
Pomysł na projekt: napisz samouczki, aby skorzystać z naszej biblioteki w ...
Problem
- Użytkownicy próbujący użyć naszej biblioteki w $TechnologyX zgłaszają wiele problemów. Nie dysponujemy jasnym przewodnikiem dotyczącym integracji z $TechnologyX, dlatego może to być trudne.
Jak możemy mierzyć skuteczność?
- Zmniejszenie liczby problemów oznaczonych tagiem „$TechnologyX”
- Wzrost liczby próśb o udostępnienie danych od nowych współtwórców, którzy pomagają nam naprawiać błędy lub uzupełniać dokumentację $TechnologyX.
- Więcej linków do naszego projektu z projektów $TechnologyX
Jakich umiejętności potrzebuje pisarz techniczny, aby pracować nad tym projektem?
- Warto mieć: znajomość technologii $TechnologyX
Wolontariusze
Zachęć członków społeczności, by zarejestrowali się, aby pomóc im w określonych zadaniach. Na przykład:
- @JaneQDev, może pomóc Ci w odpowiadaniu na pytania dotyczące $TechnologyX
- @ChenPCoder, z przyjemnością zapoznam się z prośbami o przesłanie dokumentów
Informacje kontaktowe
- Autorzy techniczni zainteresowani pracą nad tym projektem powinni wysłać e-maila na adres email@project. Dołącz linki do swoich prac technicznych lub portfolio/życiorysów/CV.
Pomysł na projekt: reorganizacja dokumentacji
Problem
- Nasza dokumentacja jest obszerna i nieuporządkowana. Wielu użytkowników rezygnuje z szukania odpowiedzi w dokumentacji i po prostu zgłaszają problemy lub zadają pytania na forach. Nasze strony nie pojawiają się w wynikach wyszukiwania nawet po wyszukaniu trafnych słów kluczowych.
Jak możemy mierzyć skuteczność?
- Lepsze SEO dla naszej dokumentacji
- Zmniejszenie liczby problemów zgłoszonych w przypadku tematów omówionych w dokumentacji
- Wzrost liczby opublikowanych dokumentów
Jakich umiejętności potrzebuje pisarz techniczny, aby pracować nad tym projektem?
- przydatne: masz doświadczenie w porządkowaniu dużych i dojrzałych zbiorów dokumentacji, rozumienie SEO;
Wolontariusze
Zachęć członków społeczności, by zarejestrowali się, aby pomóc im w określonych zadaniach. Na przykład:
- @ChenPCoder, z przyjemnością zapoznam się z prośbami o przesłanie dokumentów
Informacje kontaktowe
- Autorzy techniczni zainteresowani pracą nad tym projektem powinni wysłać e-maila na adres email@project. Dołącz linki do swoich prac technicznych lub portfolio/życiorysów/CV.
Pomysł na projekt: wprowadzanie poprawek w dokumentacji
Problem
- Mamy wiele drobnych błędów i wcześniejszych problemów związanych z naszą dokumentacją. Nasza społeczność chętnie się zgłosi i pomoże w porządkach, ale potrzebujemy kogoś, kto zorganizuje i zajmie się rozwiązaniem problemu.
Jak możemy mierzyć skuteczność?
- Liczba zamkniętych problemów związanych z dokumentacją
- Wzrost liczby opublikowanych treści i nowych współtwórców
Jakich umiejętności potrzebuje pisarz techniczny, aby pracować nad tym projektem?
- Przydatne: doświadczenie w poprawianiu dokumentacji
- Doskonałe umiejętności organizacyjne
Wolontariusze
Zachęć członków społeczności, by zarejestrowali się, aby pomóc im w określonych zadaniach. Na przykład:
- @ChenPCoder, może pomóc w nagraniu wideo i czatu w ramach poprawki oraz znajdować ochotników w innych strefach czasowych
Informacje kontaktowe
- Autorzy techniczni zainteresowani tym projektem powinni wysłać e-maila na adres email@project/open problem lub zapytać o to na naszym forum. Dołącz linki do swoich prac technicznych lub portfolio, CV lub CV.
Pomysł na projekt: przeprowadź audyt dokumentacji
Problem
- Nie wiemy, jaki jest stan naszej dokumentacji. Trudno skupić się na udoskonalaniu dokumentacji, ponieważ nie mamy planu ani nie wiemy, co jest najpilniejsze. Mamy też wiele nieaktualnych treści, które należy usunąć lub zarchiwizować.
Jak możemy mierzyć skuteczność?
- Opracowanie planu dokumentacji z ogólną akceptacją społeczności
- Spadek liczby nieaktualnych lub nieprawidłowych stron z dokumentacją
Jakich umiejętności potrzebuje pisarz techniczny, aby pracować nad tym projektem?
- Warto mieć: doświadczenie w wykonywaniu kontroli dokumentów.
Wolontariusze
Zachęć członków społeczności, by zarejestrowali się, aby pomóc im w określonych zadaniach. Na przykład:
- @JaneQCoder może pomóc w koordynacji zaprezentowania planu rozwoju dokumentacji
Informacje kontaktowe
- Autorzy techniczni zainteresowani tym projektem powinni wysłać e-maila na adres email@project/open problem lub zapytać o to na naszym forum. Dołącz linki do swoich prac technicznych lub portfolio, CV lub CV.
Powiązane artykuły
- Strona promocji i prasy zawiera logo i inne materiały, których możesz użyć, wspominając o sezonie Dokumentów Google.
- Ten film z panelu PyCon Australia 2017 zawiera wskazówki dotyczące porządkowania dokumentacji tak, aby była przydatna: Czego nikt nie mówi o dokumentacji Daniele Procida