Ta strona zawiera szczegółowe informacje na temat projektu dotyczącego pisania technicznego zaakceptowanego do udziału w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Trytona
- 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.
Dzięki ulepszeniom w dokumentacji modułu Trytona użytkownicy mogą znaleźć odpowiednie moduły, a następnie skonfigurować system i z niego korzystać. Dobra dokumentacja modułu pozwoli użytkownikom znaleźć odpowiedzi na niektóre podstawowe pytania bez konieczności oczekiwania 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.
Dokumentacja narzędzia Tryton ma 3 główne grupy odbiorców: użytkownicy, administratorzy systemu i deweloperzy. Aby ułatwić kierowanie dokumentacji na każdy z tych elementów, zalecamy rozdzielenie dokumentacji w poszczególnych modułach 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 budowy i struktury modułu. W zależności od funkcjonalności modułu niektóre z nich mogą nie być wymagane, a w razie potrzeby można utworzyć dodatkowe pliki. Udoskonalenia modułu będą podobne do tych, które już zaproponowałem: https://codereview.tryton.org/297241003/#ps327231002
Taki układ dokumentacji będzie odpowiedni, ponieważ jest ona obecnie generowana przez Sphinxa za pomocą plików reStructuredText. Gdy wprowadzam zmiany w dokumentacji, będą one przesyłane na stronę weryfikacji kodu Tryton, gdzie będzie można je sprawdzić i w razie potrzeby zaktualizować. Gdy wszyscy będą zadowoleni, wtedy będziemy mogli dodać je do Trytona.