Esta página contém os detalhes de um projeto de escrita técnica aceito para o Temporada dos Documentos Google.
Resumo do projeto
- Organização de código aberto:
- Tryton
- Redator técnico:
- dave
- Nome do projeto:
- Documentação para módulos básicos
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Neste projeto, proponho revisar e atualizar a documentação dos módulos básicos da Tryton. Esses são os módulos que as pessoas precisam ativar com mais frequência ao configurar um sistema Tryton.
As melhorias na documentação de módulos do Tryton vão ajudar os usuários a encontrar os módulos certos para suas necessidades e, em seguida, a configurar e usar o sistema. Uma boa documentação do módulo permite que os usuários encontrem as respostas para algumas 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, company, country, currency, party, product, purchase, sale e stock.
Há três públicos-alvo principais para a documentação do Tryton: usuários, administradores do sistema e desenvolvedores. Para ajudar a direcionar a documentação a cada um deles, sugiro que a documentação de cada módulo seja dividida em arquivos separados no diretório de documentos. Isso pode incluir arquivos com uma tabela de conteúdo e descrição do módulo, instruções de configuração, 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 serão semelhantes às que já propus para o módulo de festa: https://codereview.tryton.org/297241003/#ps327231002
Estruturar a documentação dessa forma vai funcionar bem porque, no momento, ela é gerada pelo Sphinx usando arquivos reStructuredText. À medida que faço alterações na documentação, elas são enviadas para o site de análise de código da Tryton, para que possam ser analisadas, e posso atualizá-las conforme necessário. Quando todos estiverem satisfeitos com eles, eles poderão ser aprovados para inclusão no Tryton.