Obecny etap:
Program Sezon Dokumentów 2021 zakończył się 14 grudnia 2021 r. Zobacz oś czasu.
Ta strona zawiera wskazówki dla organizacji open source, które pomogą im ocenić i wybrać odpowiedniego autora projektu dotyczącego projektu Season of Docs.
Wstęp
Organizacje typu open source muszą zatrudnić redaktora technicznego do pracy nad proponowanym projektem. Organizacje muszą mieć własnego autora tekstu technicznego. Autorzy tekstów technicznych, którzy chcą nawiązać współpracę z organizacjami, które korzystają z sezonu Dokumentów, znajdziesz w repozytorium Sezonu of Docs na GitHubie oraz na kanale#session-of-docs na stronie Zapisuj dokumenty.
Ocena autora technicznego
Zalecamy, aby poprosić autorów rozważnych o przykłady poprzednio opracowanej dokumentacji technicznej. Umożliwi to ocenę ich technicznych umiejętności pisania i doświadczenia.
Umiejętności i doświadczenie techniczne
Zapoznaj się z doświadczeniem autora tekstu technicznego. Najlepiej, gdyby pisarz techniczny miał doświadczenie w pisaniu dokumentacji technicznej dla branży oprogramowania. Jednym z celów programu Season of Docs jest umożliwienie autorom treści technicznych poświęconych produktom i usługom. Dlatego nawet jeśli projekt koncentruje się na odbiorcach, nie jest konieczne, aby twórca miał doświadczenie w korzystaniu z interfejsów API, pakietów SDK czy innych platform programistycznych.
Skup się na umiejętnościach językowych i komunikacyjnych. Z tego punktu widzenia należy ocenić wcześniejsze prace redaktora technicznego. Najważniejsze: czy potrafisz zrozumieć, co napisała ta osoba? Jeśli chcesz dokładnie zrecenzować język pracy autora technicznego, musisz zadbać o spójność w zakresie interpunkcji i sformułowań, poprawną pisownię i jasny język. Czy sformułowanie jest proste czy skomplikowane? Czy zdania są krótkie czy dłużą się, aż staną się trudne do zrozumienia?
Zwróć uwagę na projekt i układ dokumentów. Sprawdź ogólny układ przykładowych dokumentów. Czy projekt jest logiczny? Czy łatwo jest poruszać się po dokumencie lub zbiorze dokumentacji? Czy występują powielone treści czy jakieś oczywiste luki?