Skip to content

Adicionar documentação inicial  #31

@cmagnobarbosa

Description

@cmagnobarbosa

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.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions