Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Tryton
- Pisarz techniczny:
- dave
- Nazwa projektu:
- Dokumentacja modułów podstawowych
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
W tym projekcie proponuję przejrzeć i zaktualizować dokumentację podstawowych modułów Tryton. Są to moduły, które użytkownicy najczęściej muszą aktywować podczas konfigurowania systemu Tryton.
Ulepszenia dokumentacji modułu Tryton ułatwiają użytkownikom znajdowanie modułów odpowiednich do ich potrzeb oraz ułatwianie konfiguracji i obsługi systemu. Dobra dokumentacja modułu pozwoli użytkownikom znaleźć odpowiedzi na niektóre podstawowe pytania bez konieczności czekania na odpowiedzi na forum dyskusyjnym.
Podstawowe moduły obejmują co najmniej te moduły: account, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sale and stock.
W dokumentacji Tryton są 3 główne grupy odbiorców: użytkownicy, administratorzy systemu i deweloperzy. Aby ułatwić kierowanie dokumentacji na każdy z tych sposobów, zalecamy rozdzielenie dokumentacji każdego modułu na osobne pliki w katalogu dokumentów. Mogą to być pliki ze spisem treści i opisem modułu, instrukcjami jego konfigurowania, sposobem korzystania z modułu oraz szczegółami dotyczącymi konstrukcji i struktury modułu. W zależności od funkcji modułu niektóre z nich mogą nie być wymagane, a w razie potrzeby można utworzyć dodatkowe. Udoskonalenia modułu będą podobne do tych, które już zaproponowałem(-am) w module imprezy: https://codereview.tryton.org/297241003/#ps327231002
Struktura takiej dokumentacji będzie dobrze wyglądać, ponieważ jest obecnie generowana przez Sphinxa za pomocą plików reStructuredText. Gdy wprowadzę zmiany w dokumentacji, będą one przesyłane do witryny weryfikacji kodu Tryton, gdzie będzie można je sprawdzić, a następnie w razie potrzeby zaktualizować. Gdy wszyscy będą zadowoleni, możemy zaakceptować zgłoszenie do programu Tryton.