Obecny etap:
Ogłoszenie wyników 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ą jedynie przykładami pokazującymi, jak organizacje mogą opisywać możliwe projekty związane z dokumentacją na stronie pomysłów na projekty organizacji. Organizacje mogą zaproponować projekty, których nie ma na tej liście.
Pomysł na projekt: przewodnik wprowadzający dla współtwórców
Problem
- Nowi współtwórcy nie będą mogli znaleźć informacji konfiguracyjnych, których potrzebują, aby w jakiś sposób przyczyniać się do rozwoju naszego projektu. Niektóre procesy (np. udział w testach) nie są w ogóle udokumentowane.
Jak możemy mierzyć skuteczność?
- wzrost liczby nowych współtwórców.
- zwiększenie liczby nowych współtwórców niewymagających umiejętności kodowania (dzięki ułatwieniu współtworzenia dokumentów i testów);
- Zmniejszenie liczby problemów zgłaszanych przez nowych współtwórców
- Wzrost liczby zamkniętych problemów oznaczonych tagiem „Pierwszy dobry problem”
Jakich umiejętności potrzebuje pisarz techniczny, aby pracować nad tym projektem?
- Wymagane: Znajomość serwisu GitHub (lub chęć korzystania z samouczków na GitHubie)
- Warto mieć: znać osobę uczestniczącą w programie testowym, co pozwoli na przeprowadzenie testów i zaktualizowanie dokumentacji
Wolontariusze
Zachęć członków społeczności, by pobrali pomoc w wykonywaniu określonych zadań, na przykład:
- @JaneQDev: mogę pomóc Ci w udzieleniu odpowiedzi na pytania dotyczące naszych testów
- @ChenPCoder, chętnie 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 tekstu technicznego.
Informacje kontaktowe
- Autorzy techniczni zainteresowani pracą nad tym projektem powinni wysłać e-maila na adres email@project. Uwzględnij linki do prac technicznych lub portfolio, CV, CV.
Pomysł na projekt: napisz samouczki, aby skorzystać z naszej biblioteki z ...
Problem
- Wiele problemów w naszym projekcie zgłaszają użytkownicy próbujący wykorzystać bibliotekę $TechnologyX. $TechnologyX nie oferuje jasnego przewodnika do integracji z technologią $TechnologyX i może być trudnym zadaniem.
Jak możemy mierzyć skuteczność?
- Zmniejszenie liczby problemów z tagiem „$TechnologyX”
- Wzrost liczby próśb o wyciąganie wniosków od nowych współtwórców, pomagających nam w naprawianiu błędów i uzupełnianiu dokumentacji dotyczącej $TechnologyX.
- Więcej linków do naszego projektu $TechnologyX
Jakich umiejętności potrzebuje pisarz techniczny, aby pracować nad tym projektem?
- Warto mieć: pewną znajomość $TechnologyX
Wolontariusze
Zachęć członków społeczności, by pobrali pomoc w wykonywaniu określonych zadań, na przykład:
- @JaneQDev, chętnie odpowiem na pytania dotyczące $TechnologyX
- @ChenPCoder, chętnie 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. Dodaj linki do swoich tekstów technicznych lub portfolio, CV, życiorysu zawodowego.
Pomysł na projekt: reorganizacja naszej dokumentacji
Problem
- Nasza dokumentacja jest obszerna i uporządkowana. Wielu użytkowników poddaje się, próbując znaleźć odpowiedzi w dokumentacji, i zamiast tego zgłaszają problemy lub zadaje pytania na naszych forach. Nasze strony nie pojawiają się w wynikach wyszukiwania nawet w przypadku trafnych słów kluczowych.
Jak możemy mierzyć skuteczność?
- Lepsze SEO w naszej dokumentacji
- Zmniejszenie liczby zgłaszanych problemów w przypadku tematów omówionych w dokumentacji
- Wzrost liczby darowizn
Jakich umiejętności potrzebuje pisarz techniczny, aby pracować nad tym projektem?
- Przydatne: doświadczenie w porządkowaniu dużych i dojrzałych zbiorów dokumentacji, znajomość SEO
Wolontariusze
Zachęć członków społeczności, by pobrali pomoc w wykonywaniu określonych zadań, na przykład:
- @ChenPCoder, chętnie 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. Dodaj linki do swoich tekstów technicznych lub portfolio, CV, życiorysu zawodowego.
Pomysł na projekt: wprowadzenie poprawek w dokumentacji
Problem
- Mamy sporo błędów i starych problemów związanych z naszą dokumentacją. Nasza społeczność chętnie się do nas zgłasza i pomaga w porządkach, ale potrzebujemy kogoś, kto zorganizuje i poprowadzi poprawki.
Jak możemy mierzyć skuteczność?
- Liczba zamkniętych problemów związanych z dokumentacją
- Wzrost liczby publikowanych dokumentów 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 pobrali pomoc w wykonywaniu określonych zadań, na przykład:
- @ChenPCoder, pomoże Ci zorganizować film i czat, by rozwiązać problem, oraz znaleźć ochotników w innych strefach czasowych
Informacje kontaktowe
- Autorzy techniczni zainteresowani pracą nad tym projektem powinni wysłać e-maila na adres email@project/otwarcie problemu lub zadać pytanie na naszym forum. Dodaj linki do swoich prac technicznych lub portfolio, CV.
Pomysł na projekt: przeprowadzenie kontroli dokumentacji
Problem
- Nie wiemy, jaka jest stan naszej dokumentacji. Trudno jest skupić się na ulepszaniu dokumentacji, ponieważ nie mamy planu ani nie wiemy, jakie są najpilniejsze problemy. Mamy też wiele nieaktualnych treści, które powinny zostać usunięte lub zarchiwizowane.
Jak możemy mierzyć skuteczność?
- Opracowanie planu dokumentacji dotyczącej dokumentacji zatwierdzonej przez społeczność.
- Zmniejszenie liczby nieaktualnych lub nieprawidłowych stron z dokumentacją
Jakich umiejętności potrzebuje pisarz techniczny, aby pracować nad tym projektem?
- Przydatne: doświadczenie w prowadzeniu kontroli dokumentów
Wolontariusze
Zachęć członków społeczności, by pobrali pomoc w wykonywaniu określonych zadań, na przykład:
- @JaneQCoder może pomóc w koordynowaniu prezentacji harmonogramu dotyczącego dokumentacji podczas spotkania społeczności.
Informacje kontaktowe
- Autorzy techniczni zainteresowani pracą nad tym projektem powinni wysłać e-maila na adres email@project/otwarcie problemu lub zadać pytanie na naszym forum. Dodaj linki do swoich prac technicznych lub portfolio, CV.
Powiązane artykuły
- Strona dotycząca promocji i prasy zawiera logo i inne treści, których możesz użyć, wspominając o sezonie w Dokumentach.
- Ten film z programu PyCon Australia 2017 zawiera wskazówki dotyczące porządkowania dokumentacji w taki sposób, aby była ona przydatna: What nobody help you about document (Czego nikt nie mówi o dokumentacji) autorstwa Daniele Procida.