TODO dokumentacji — Co wciąż trzeba napisać

Ten plik śledzi braki w dokumentacji i pomysły na ulepszenia. Służy zarówno jako mapa drogowa, jak i przypomnienie, że dokumentacja — jak oprogramowanie — nigdy nie jest naprawdę skończona.

Wysoki priorytet

Zadanie Status Uwagi
referencja znaczników kontrolek wxPython Oczekuje Udokumentuj wszystkie znaczniki kontrolek % wx_* z tabelami parametrów
API systemu wtyczek Oczekuje System wtyczek potrzebuje pełnej dokumentacji API
Przewodnik tworzenia mobilnego (Kivy) Oczekuje dedykowany przewodnik dla developmentu Android/Kivy
Samouczek integracji C/Nim/Zig Oczekuje krok po kroku dla skompilowanych rozszerzeń

Średni priorytet

Zadanie Status Uwagi
Ukończ dokumentację modułów schdata_* Częściowo zrobione Kilka plików _schdata_* potrzebuje treści
Przewodnik konfiguracji dostawcy OAuth Oczekuje szczegółowy opis konfiguracji
Książka kucharska wdrażania Oczekuje przepisy dla AWS, Hetzner, DigitalOcean
Przewodnik strojenia wydajności Oczekuje profilowanie, techniki optymalizacji
Przewodnik testowania Oczekuje testy jednostkowe, integracyjne, dane testowe

Niski priorytet

Zadanie Status Uwagi
Storyboard samouczków wideo Oczekuje zarys 5-minutowych samouczków wideo
Krosowanie referencji API W toku dodaj odsyłacze między dokumentacją API a przewodnikami
Ustandaryzowanie formatu changelogu Oczekuje przyjmij format Keep a Changelog
Przewodnik dla współtwórców Oczekuje jak współtworzyć Pytigona

Wytyczne stylu dokumentacji

Dla współtwórców dodających dokumentację:

  1. Używaj składni .ihtml dla rozszerzonego markdowna — linie zaczynające się od % są specjalne
  2. Pisz dla obu odbiorców — programisty znającego Django ORAZ nowicjusza
  3. Pokazuj, nie tylko opisuj — każde pojęcie powinno mieć przykład kodu
  4. Agresywnie odsyłaj — linkuj do powiązanych tematów używając składni Topic
  5. Trzymaj techniczność, ale bądź ludzki — dokumentacja czytana jak podręcznik nikogo nie czyta. Dokumentacja czytana jak rozmowa — ludzie ją zapamiętują.

Jak oznaczyć zadanie jako ukończone

Zastąp Pending lub In progress przez Completed i dodaj datę. Przenieś ukończone pozycje do sekcji „Ostatnio ukończone” poniżej.

?: Documentaction ?: Documentaction