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:
- Infrastruktura kompilatora LLVM
- Pisarz techniczny:
- DR87
- Nazwa projektu:
- Zmiana struktury indeksu dokumentacji LLVM i poradnika stylu dokumentacji
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Ten projekt obejmuje te zadania:
a.) Zmień strukturę strony indeksu dokumentacji, aby była bardziej przyjazna dla użytkowników. Zadanie to obejmuje ocenę bieżącej strony i jej przebudowę na podstawie połączenia niezależnych badań, wywiadów z małymi firmami i opinii użytkowników. Możliwe opcje to zmiana krótkich opisów, zmiana struktury istniejącej strony lub dodanie kolejnych warstw (stron) w ramach modelu stopniowego ujawniania informacji. Druga opcja polegałaby na zmniejszeniu liczby linków na głównej stronie indeksu, aby ułatwić użytkownikom znajdowanie konkretnych informacji lub przewodników. Indeks może zawierać linki do osobnych stron z informacjami o projektowaniu i ogólnym omówieniu LLVM, przewodnikami użytkownika, dokumentacją podsystemów oraz dokumentacją procesu programowania.
b.) Zaktualizuj przewodnik po stylu LLVM Sphinx dla autorów pracujących nad oprogramowaniem open source. Zadanie będzie obejmować ocenę obecnego przewodnika, zidentyfikowanie luk w danych za pomocą niezależnych badań i wywiadów z małymi i średnimi przedsiębiorstwami oraz zaktualizowanie podręcznika zgodnie z uzgodnionymi wymaganiami. Aktualizacje mogą obejmować zmianę układu przewodnika, dodanie nowych treści i wstawienie linków do odpowiednich stron, np. przewodnika dla autorów. Ostatecznym celem jest ułatwienie wolontariuszom jak najszybszego rozpoczęcia pracy.