Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- Tentar
- Redator técnico:
- dave
- Nome do projeto:
- Documentação dos módulos básicos
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Neste projeto, proponho a revisão e atualização da documentação dos módulos básicos do tryton. Estes são os módulos que as pessoas mais precisam ativar ao configurar um sistema tryton.
As melhorias na documentação do módulo do tryton vão ajudar os usuários a encontrar os módulos certos para as necessidades deles e a configurar e usar o sistema. Uma boa documentação do módulo permitirá que os usuários encontrem as respostas para algumas de suas perguntas básicas sem precisar esperar por respostas no fórum de discussão.
Os módulos básicos incluem, no mínimo, os módulos account, account_invoice, account_invoice_stock, account_product, empresa, país, moeda, festa, produto, compra, venda e estoque.
Há três públicos-alvo principais para a documentação do app: usuários, administradores de sistema e desenvolvedores. Para ajudar a direcionar a documentação a cada um desses tópicos, sugiro que a documentação de cada módulo seja dividida em arquivos separados dentro do diretório doc. Eles podem incluir arquivos com o sumário e a descrição do módulo, instruções para configurar o módulo, informações sobre como usar o módulo e detalhes sobre o design e a estrutura do módulo. Dependendo da funcionalidade do módulo, alguns desses arquivos podem não ser necessários, e arquivos extras podem ser criados conforme necessário. As melhorias do módulo vão seguir as que já propusei para o módulo da festa: https://codereview.tryton.org/297241003/#ps327231002
Estruturar a documentação dessa forma funcionará bem porque ela é gerada atualmente pelo Sphinx usando arquivos reStructuredText. Conforme eu fizer alterações na documentação, elas serão enviadas para o site de revisão de código da tryton, para que possam ser revisadas e possam ser atualizadas conforme necessário. Assim que todos estiverem satisfeitos, esperamos que a inclusão no programa será aprovada.