Skip to content

Atualizar README com a documentação real do projeto e das apps que o compõem #736

Description

@pitangainnovare

Descrição da tarefa

Atualizar o README para refletir de forma clara o que o projeto de fato é e faz, documentando os principais módulos funcionais: article, etl, harvest, indicator*, observation, search e search_gateway. A documentação deve substituir o conteúdo genérico por uma visão operacional do SCMS OCA, explicando o papel de cada módulo e como eles se conectam no fluxo de ingestão, processamento, indicadores e busca.

Subtarefas

  • Revisar o README atual e identificar trechos genéricos, desatualizados ou insuficientes.
  • Documentar o propósito geral do projeto e seu papel no contexto do SCMS OCA.
  • Descrever o módulo etl, incluindo EtlPipelineConfig, add_rules, deduplicação SciELO, matching OpenAlex e indexação silver.
  • Descrever o módulo harvest e seu papel na coleta/ingestão de dados.
  • Descrever os módulos indicator* e sua relação com indicadores, relatórios ou visualizações analíticas.
  • Descrever o módulo observation e seu papel no acompanhamento/observações do sistema.
  • Descrever o módulo search e a experiência de busca disponível ao usuário.
  • Descrever o módulo search_gateway e sua função como camada de integração/lookup para busca.
  • Revisar comandos operacionais relevantes de bootstrap, fixtures e atualização de dados.
  • Validar a documentação com uma leitura final e busca pelos principais termos documentados.
  • Apontar apps e códigos que podem ser removidos.

Considerações e notas

  • Esta tarefa é apenas de documentação e não deve alterar comportamento do sistema.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions