Tryton 프로젝트

이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:
Tryton
기술 문서 작성자:
데이브
프로젝트 이름:
기본 모듈 문서
프로젝트 길이:
표준 기간 (3개월)

Project description

이 프로젝트에서는 기본 Tryton 모듈의 문서를 검토하고 업데이트할 것을 제안합니다. 다음은 Tryton 시스템을 설정할 때 가장 일반적으로 활성화해야 하는 모듈입니다.

Tryton의 모듈 문서가 개선되면 사용자가 필요에 맞는 올바른 모듈을 찾고 시스템을 설정하고 사용하는 데 도움이 됩니다. 우수한 모듈 문서를 사용하면 사용자가 토론 포럼에서 답변을 기다릴 필요 없이 일부 기본 질문에 대한 답변을 찾을 수 있습니다.

기본 모듈에는 최소한 account, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sales 및 stock 모듈이 포함됩니다.

Tryton 문서에는 사용자, 시스템 관리자, 개발자의 세 가지 주요 대상이 있습니다. 문서를 각각 타겟팅하는 데 도움이 되도록 각 모듈의 문서를 doc 디렉터리 내에서 별도의 파일로 분할하는 것이 좋습니다. 여기에는 목차 및 모듈 설명, 모듈 설정 안내, 모듈 사용 방법 정보, 모듈의 설계 및 구조에 대한 세부정보가 포함된 파일이 포함될 수 있습니다. 모듈의 기능에 따라 이러한 파일 중 일부가 필요하지 않을 수 있으며 필요에 따라 추가 파일을 만들 수 있습니다. 모듈 개선사항은 파티 모듈에 대해 이미 제안한 사항(https://codereview.tryton.org/297241003/#ps327231002)과 동일한 방식으로 이루어집니다.

문서는 현재 reStructuredText 파일을 사용하여 Sphinx에서 생성되므로 문서를 이렇게 구성하면 좋습니다. 문서를 변경하면 Tryton 코드 검토 사이트에 업로드되므로 검토할 수 있으며 필요에 따라 업데이트할 수 있습니다. 모든 직원이 만족스러우면 Tryton에 포함되도록 승인을 받을 수 있습니다.