이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- 트라이턴
- 테크니컬 라이터:
- 데이브
- 프로젝트 이름:
- 기본 모듈 문서
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
이 프로젝트에서 기본 Tryton 모듈에 관한 문서를 검토하고 업데이트할 것을 제안합니다. 이러한 모듈은 Tryton 시스템을 설정할 때 가장 일반적으로 활성화해야 하는 모듈입니다.
Tryton의 모듈 문서를 개선하면 사용자가 자신의 필요에 맞는 모듈을 찾고 시스템을 설정하고 사용하는 데 도움이 됩니다. 훌륭한 모듈 문서를 통해 사용자는 토론 포럼에서 답변을 기다릴 필요 없이 기본적인 질문에 대한 답변을 찾을 수 있습니다.
기본 모듈에는 최소한 account, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sales, 재고 모듈이 포함됩니다.
Tryton 문서에는 사용자, 시스템 관리자, 개발자의 세 가지 주요 대상이 있습니다. 문서를 이러한 각 항목에 맞추려면 각 모듈의 문서를 doc 디렉터리 내에 별도의 파일로 분할하는 것이 좋습니다. 여기에는 목차 및 모듈 설명, 모듈 설정 안내, 모듈 사용 방법에 대한 정보, 모듈의 설계 및 구조에 대한 세부정보가 포함된 파일이 포함될 수 있습니다. 모듈의 기능에 따라 이러한 파일 중 일부는 필요하지 않을 수 있으며 필요에 따라 추가 파일을 만들 수 있습니다. 모듈 개선사항은 제가 이미 파티 모듈에 대해 제안한 라인(https://codereview.tryton.org/297241003/#ps327231002)과 함께 제공될 예정입니다.
문서가 현재 reStructuredText 파일을 사용하여 Sphinx에서 생성되므로 이와 같이 문서를 구조화하는 것이 좋습니다. 서류를 변경하면 Tryton 코드 검토 사이트에 업로드되므로 검토를 거쳐 필요에 따라 업데이트할 수 있습니다. 모든 사람이 만족하면 Tryton에 포함되도록 승인받을 수 있습니다.