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:
- Tryton
- Specjalista ds. technicznych:
- dave
- Nazwa projektu:
- Dokumentacja dotycząca podstawowych modułów
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
W ramach tego projektu proponuję przejrzeć i zaktualizować dokumentację podstawowych modułów Tryton. To moduły, które użytkownicy najczęściej muszą aktywować podczas konfigurowania systemu Tryton.
Ulepszenia w dokumentacji modułów Tryton pomogą użytkownikom znaleźć odpowiednie moduły do ich potrzeb, a następnie skonfigurować i używać systemu. Dobra dokumentacja modułu pozwoli użytkownikom znaleźć odpowiedzi na niektóre podstawowe pytania bez konieczności czekania na odpowiedzi na forum dyskusyjnym.
Do modułów podstawowych należą co najmniej: account, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sale i stock.
Dokumentację Tryton kierujemy do 3 głównych grup odbiorców: użytkowników, administratorów systemów i programistów. Aby ułatwić ukierunkowanie dokumentacji na każdy z tych modułów, sugerujemy podzielenie dokumentacji każdego modułu na osobne pliki w katalogu dokumentów. Mogą to być pliki zawierające spis treści i opis modułu, instrukcje jego konfigurowania, informacje o sposobie korzystania z modułu oraz szczegóły dotyczące jego projektu i struktury. W zależności od funkcji modułu niektóre z tych plików mogą nie być wymagane, a w razie potrzeby można utworzyć dodatkowe pliki. Ulepszenia modułu będą podobne do tych, które zostały już zaproponowane w przypadku modułu party: https://codereview.tryton.org/297241003/#ps327231002
Taka struktura dokumentacji będzie odpowiednia, ponieważ jest ona obecnie generowana przez Sphinxa za pomocą plików reStructuredText. Gdy wprowadzę zmiany w dokumentacji, zostaną one przesłane na stronę Tryton do sprawdzenia kodu, aby można je było przejrzeć. W razie potrzeby mogę je zaktualizować. Gdy wszyscy będą zadowoleni, możemy je zatwierdzić do włączenia do Tryton.