Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- Kaleidoscope
- Specjalista ds. technicznych:
- techwriterjill
- Nazwa projektu:
- Tworzenie i ulepszanie dokumentacji Kaleidoscope
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Jako pisarz bardzo interesuję się tym projektem. Obecnie używam klawiatury ergonomicznej, która nie ma możliwości modelu Kaleidoscope 01, ale znajomość układu klawiatury podzielonej na dwie części pomoże mi w pierwszych etapach testowania i poznawania funkcji oprogramowania układowego. Moje doświadczenie jako użytkownika podobnych produktów pomoże mi również w określeniu funkcji i dokumentacji, które są przydatne dla innych użytkowników.
Mam doświadczenie w dokumentowaniu instalacji i konfiguracji złożonych produktów i bardzo lubię tego typu pracę. Lubię też rozumieć produkty i procesy (w tym przypadku będzie to dość dosłowne), aby zapoznać się z produktami i procesami, aby o nich pisać. Dzięki temu mogę tworzyć wysokiej jakości dokumentację, która jest naprawdę przydatna dla użytkowników.
Zanim zostałam dedykowanym autorem dokumentacji technicznej, pracowałam jako analityk w zespole pomocy. Dzięki temu zdobyłam cenne umiejętności, które przydały mi się w tym projekcie, np. kompilowanie kodu, testowanie, analizowanie i powielanie problemów.
Pierwszy kontakt z Jessem i Gergely z firmy Kaleidoscope został omyłkowo opracowany i opracowaliśmy wstępny plan, który po zaakceptowaniu pozwoli mi pracować nad tymi projektami, które uznali za najbardziej wartościowe dla swoich użytkowników:
- Dokumentowanie wtyczek sprzętowych
- Dokumentacja dotycząca pisania makr dla początkujących użytkowników
- Opisz dostępne wtyczki
Pracuję w pełnym wymiarze godzin, więc w sezonie świątecznym mogę poświęcić około 10 godzin tygodniowo. Dzięki temu będę mogła realizować więcej mniejszych projektów oprócz powyższych. Podczas badania aplikacji Kaleidoscope zauważyłem, że jedyny przyjazny użytkownikowi opis produktu znajduje się na stronie Kickstarter. Początkowy projekt crowdfundingowy zakończył się w 2015 r., więc uważam, że potrzebna jest witryna skierowana do użytkowników. Nie jestem programistą stron internetowych, ale chętnie podzielę się pomysłami i przekażę tekst dotyczący witryny, jeśli firma Kaleidoscope będzie zainteresowała się tym tematem.
Jesse i Gergely zaoferowali wysłanie klawiatury zwycięskiemu autorowi. Myślę, że to będzie kluczowe dla powodzenia projektu.
Uważam, że moje umiejętności i doświadczenie czynią mnie idealnym kandydatem do tego projektu. Czekam na odpowiedź.