Pomysły na projekty

Obecny etap:
Program Sezon Dokumentów 2019 zakończył się 6 marca 2020 r. Zobacz oś czasu.

Pomysły na projekty to sugestie organizacji open source dotyczące projektów, które autor techniczny może zrealizować we współpracy z mentorem w trakcie korzystania z Dokumentów.

Informacje na tej stronie są przeznaczone dla administratorów organizacji open source i mentorów, którzy przygotowują listę pomysłów na projekty. Informacje te są też przydatne dla autorów tekstu przeznaczonego dla podmiotów technicznych jako tła ułatwiającego organizacjom uczestnictwo organizacji w programie Seasonal of Docs.

Przykładowe projekty

Poniżej znajdziesz kilka pomysłów na projekty, w których może zająć się zawodowiec techniczny:

  • Zbudować witrynę z dokumentacją na platformie, na którą będą decydować autor techniczny i mentor open source, a następnie opublikować w niej początkowy zestaw podstawowych dokumentów. Przykłady platform:

  • Zrefaktoryzować dotychczasową dokumentację projektu open source, aby zapewnić użytkownikom lepsze wrażenia lub uzyskać łatwiejszą architekturę informacji.

  • Napisać ogólne omówienie lub wprowadzenie do produktu lub funkcji. Zespół często opracowuje dokumentację techniczną od podstaw, w efekcie której jest bardzo dużo szczegółów, ale trudno jest zrozumieć ją jako całość. Pisarz techniczny może to naprawić.

  • Utworzyć samouczek dotyczący ogólnego przypadku użycia.

  • Utwórz zestaw szczegółowych instrukcji dotyczących konkretnych zadań.

  • Przewodnik dla współtwórcy zawiera podstawowe informacje o tym, jak rozpocząć pracę jako współtwórca projektu open source, a także wszelkie reguły dotyczące umów licencyjnych, procesów związanych z wnioskami typu „push” i weryfikacją, tworzeniem projektu itd.

Powyższe propozycje celowo różnią się pod względem zakresu i rozmiaru. Długość czasu potrzebnego na projekt zależy od wielu czynników, m.in. od rozmiaru zbioru dokumentacji, złożoności usługi, doświadczenia autora projektu i mentorów open source, a także od narzędzi i procesów oferowanych w ramach projektu open source.

Powyższa lista ma na celu pierwsze kroki. Możesz też zaproponować inne rodzaje projektów.

Opublikuj listę pomysłów na projekty

Pomysły należy publikować na publicznej stronie internetowej, w poście na blogu lub w innym publicznie dostępnym dokumencie.

Strona z pomysłami na projekt powinna zawierać:

  • Informacje o Twojej organizacji open source:

    • Nazwa organizacji.
    • Opis organizacji.
    • Link do Twojego repozytorium open source lub strony internetowej.
    • (Opcjonalnie) Adres e-mail, pod którym można skontaktować się z Twoją organizacją w sprawie sezonu Dokumentów. Powinien on być taki sam jak adres e-mail podany w formularzu zgłoszeniowym organizacji dotyczącym programu Seasonal of Docs.
    • (Opcjonalnie) Informacje o administracji i mentorach w organizacji, np. ich wyświetlane nazwy. Powinny one być takie same jak nazwy wyświetlane w formularzu zgłoszeniowym organizacji dotyczącym sezonu Dokumentów.

  • Ogłoszenie, że Twoja organizacja chce dołączyć do tegorocznego Sezonu Dokumentów. Strona dotycząca promocji i prasy zawiera logo i inne treści, których możesz użyć, wspominając o sezonie w Dokumentach.

  • Twoje pomysły na projekt, w tym informacje o każdej koncepcji opisane poniżej.

Tworząc zgłoszenie swojej organizacji do programu Season of Docs, dołącz link do strony z pomysłami na projekty.

Informacje zawarte w każdej propozycji projektu

Każdy pomysł na projekt musi zawierać co najmniej te informacje:

  • Nazwa projektu: wybierz zwięzły, ale opisowy tytuł.
  • Opis: dłuższy opis wymaganych zadań z dokumentacją. Opisz szczegółowo swój początkowy pomysł. Zaoferuj wszystkim zainteresowanym specjalistom ds. technicznych możliwość rozwijania lub doprecyzowania pomysłu.

  • Powiązane materiały:

    • Link do projektu open source, który wymaga dokumentacji.
    • Jeśli proponujesz projekt techniczny, który obejmuje aktualizacje istniejącego zestawu dokumentacji, podaj link do tego zbioru.
    • Jeśli proponujesz samouczek lub zestaw instrukcji, opisz funkcje lub przypadki użycia, które wymagają udokumentowania.
    • Jeśli proponowasz przewodnik dla współtwórcy, dodaj link do pliku README lub do innych odpowiednich materiałów, jeśli taki istnieje. Jeśli na razie nic nie jest dostępne, możesz śmiało podać tę informację.
    • W razie potrzeby podaj linki do podobnej dokumentacji w innych projektach.

Znaczenie pomysłów projektu

Pomysły na projekty są ważne pod wieloma względami:

  • Opracowanie koncepcji pomoże organizacji opracować niezbędne zadania związane z dokumentacją i przygotować się do pracy z autorami treści technicznych.
  • Pomysły na projekty zapewniają administratorom programu Google wskazówkę typu pracy, jaką będzie wykonywać autor tekstu technicznych po rozpoczęciu współpracy z Twoją organizacją w zakresie mentoringu. Administratorzy programu Google wykorzystują pomysły na projekty, by ocenić zaangażowanie organizacji w programie Dokumentów Google i opiekować się autorem tekstu technicznego przez cały program.
  • Pomysły na projekty przyciągają do organizacji zainteresowanych twórców technicznych. Mogą oni wykorzystać proponowane przez Ciebie projekty jako podstawy do stworzenia własnych propozycji projektów.
  • 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.