Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Infrastruktura kompilatora LLVM
- Pisarz techniczny:
- DR87
- Nazwa projektu:
- Zmiana struktury indeksu dokumentacji LLVM i przewodnika po stylu dokumentacji
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Ten projekt obejmuje następujące zadania:
a.) Zmień strukturę strony indeksu dokumentacji, aby była bardziej przyjazna dla użytkownika. To zadanie polega na ocenie bieżącej strony i jej restrukturyzacji na podstawie niezależnych badań, wywiadów z SME i opinii użytkowników. Możliwe opcje to poprawienie krótkich opisów, przebudowanie dotychczasowej strony lub dodanie kolejnych warstw (stron) za pomocą progresywnego modelu ujawniania informacji. Ograniczy to liczbę linków na głównej stronie indeksu, aby ułatwić użytkownikom znalezienie konkretnych informacji/przewodników. Indeks może na przykład zawierać linki do oddzielnych stron z dokumentacją projektowania i przeglądu LLVM, podręczników użytkownika, dokumentacji podsystemu i dokumentów procesów deweloperskich.
b.) Zaktualizuj przewodnik po stylu LLVM Sphinx dla współtwórców open source. Celem tego zadania będzie ocena bieżącego przewodnika, zidentyfikowanie luk w niezależnych badaniach i wywiadach z SME oraz zaktualizowanie przewodnika na podstawie uzgodnionych wymagań. Mogą one obejmować zmianę układu przewodnika, dodawanie nowych treści i wstawianie linków do odpowiednich stron, takich jak przewodnik dla współtwórców. Ma to ułatwić wolontariuszom jak najszybsze rozpoczęcie współpracy.