-
Notifications
You must be signed in to change notification settings - Fork 1
Description
Objetivo:
Estruturar a documentação técnica do ProsaAI, detalhando a arquitetura do projeto, principais módulos e fluxo de funcionamento, além de definir um padrão para futuras documentações.
Tarefas:
Criar uma seção de documentação técnica descrevendo:
-
Arquitetura do projeto.
-
Principais módulos e suas responsabilidades.
-
Fluxo de funcionamento.
-
Definir um padrão de docstrings para o código (Google Style, NumPy Style ou reStructuredText).
-
Adicionar instruções básicas de uso e contribuição na documentação.
-
Explorar ferramentas como Sphinx ou pdoc para futura automação da documentação.
Critérios de Aceitação:
-
Documentação técnica inicial criada e organizada no repositório.
-
Padrão de docstrings definido e aplicado em alguns trechos do código.
-
Guia básico de uso e contribuição documentado.