[Gastosabertos] Modelo Conceitual de Apresentação da API

Domingo Dezembro 6 23:06:59 UTC 2015

Oi,

Abrindo a discussão aqui acaso alguém mais queira participar que rolou no
chat hoje (tem um card disso no Trello também com esse mesmo texto):

Isso aqui surgiu de uma discussão com a Sibi no Telegram sobre o que
deveria estar exibindo na API para que ambos Jornalistas e Desenvolvedores
pudessem entender o que está disponível de dados.

Concordamos a principio que uma casca explicando o "Journalist Way" e o
"Dev Way" seria interessante já que o uso seria bem distinto. Algumas
ideias da distinção foram colocados no artigo que a @isisreis começou a
fazer, então acho que essa discussão aqui beneficiaria ideias pro artigo
sobre APIs mais pra frente quando a ideia amadurecer.

Daí a discussão evoluiu para o que deve aparecer para a API:
------------------------------

A) Nome da API (não assuma nada, mindmap ajuda até a saber se isso seria o
A)

B) Guarda-chuva: Orcamento/ contrato?

C) Visão: Essa API mostra o cruzamento do dado x, y e z, mas deixa o dado W
de lado

D) Source: (fonte dos dados xyzwpmqetc)

D. 1) Tratamento (veio numa tabela que foi Edgada para um xml que colocou
os dados xy e z disponíveis no meio da bagunça)

E.) Jornalista sexy
E) MEDELS SEILA COMOFAS (o que um jornalista precisa saber para meter a mão
na API

F) Desenvolvedor sexy ( o que o dev precisa saber para Meter a Mão e
multiplicar a API)
------------------------------

Por fim da ideia do mindmap saiu esse "processo" para servir de imagem de
fundo e um jornalista ou desenvolvedor poder clicar e ir para os endpoints
dos Dados.

[image: Inline image 1]

(A sibi esta me ajudando a fazer algo menos bizarro). Note que podemos
reusar a mesma imagem em outras partes do site para explicar todo o
processo, e reusa-la sendo clicavel na seção de dados o que facilitaria
muito o entendimento já que teriamos um só modelo por trás. Outras imagens
poderiam extender isso para outros conceitos que O Marin comentou:

[image: Inline image 8]

Etc etc. O "big picture" eu acho fundamental a gente ter como coração do
site então estou levantando a discussão já que nomes por nomes normalmente
todo mundo se perde e deixa a coisa mais obscura :-)

Notem que a ideia é dar contexto onde cada coisa se encontra no ano Fiscal,
mas indo um pouco além isso serve de base tanto para a organização do site
e do endpoint, pois do jeito atual parece que é tudo separado na pratica
(página receita, execução e contratos ; idem na organização dos endpoints
da API).

Segundo o Edgar parece que é o caso no município de SP mas Salvador já não
é (i.e. da para ligar os dados):

[image: Inline image 2]

Então acho mais válido se espelhar no modelo mesmo que os dados da cidade
de SP não reflitam pois pode confundir se alguém quiser buscar além (talvez
via e-sic ou ligando para secretarias).

Por fim notem que também coloquei de referência quem fiscaliza interno e
externo conforme o @fabianoangelico1 mencionou hoje via e-mail, a TCM e a
CGM, bem como a menção dos observatórios que existem no município para
acompanhar os indicadores. Provavelmente os melhores guias para um
jornalista bater o olho e saber onde pode ter irregularidade para navegar
os dados (?).

Indo um pouco além, talvez nessa ou em outras figuras seja util refletir
melhor a estrutura mencionada pelo Marin para usar de contexto os endpoints
dos dados ou as colunas:

[image: Inline image 3]

[image: Inline image 5]

e lembrar também do detalhamento de ações:

[image: Inline image 6]

 que ele levantou na aula onde são listados -- produtos -- de ações o que
não está claro ainda se só não existe a nível de pdf e é uma das melhores
formas de inspecionar os indicadores por ser super específico o que é feito
e onde ocorre. Edgar sugeriu que fica em "ProgramaAções" mas acho que ali
são Ações apenas, não os produtos.

Vale lembrar que o curso online do senado tem umas figuras feito a mão
muito muito bacanas que mostram alguns pedaços desse draft que eu fiz. Por
exemplo vejam receita indo para secretarias logo abaixo.

[image: Inline image 7]

Carlos Andrade
http://carlosandrade.co
-------------- Próxima Parte ----------
Um anexo em HTML foi limpo...
URL: <http://lists.okfn.org/pipermail/gastosabertos/attachments/20151206/2e7203f2/attachment-0002.html>
-------------- Próxima Parte ----------
Um anexo não-texto foi limpo...
Nome: Screenshot_2015-12-06_11.52.45.png
Tipo: image/png
Tamanho: 74040 bytes
Descrição: não disponível
URL: <http://lists.okfn.org/pipermail/gastosabertos/attachments/20151206/2e7203f2/attachment-0014.png>
-------------- Próxima Parte ----------
Um anexo não-texto foi limpo...
Nome: Screenshot_2015-11-16_16.47.36.png
Tipo: image/png
Tamanho: 573047 bytes
Descrição: não disponível
URL: <http://lists.okfn.org/pipermail/gastosabertos/attachments/20151206/2e7203f2/attachment-0015.png>
-------------- Próxima Parte ----------
Um anexo não-texto foi limpo...
Nome: Screenshot_2015-12-06_00.31.52.png
Tipo: image/png
Tamanho: 148043 bytes
Descrição: não disponível
URL: <http://lists.okfn.org/pipermail/gastosabertos/attachments/20151206/2e7203f2/attachment-0016.png>
-------------- Próxima Parte ----------
Um anexo não-texto foi limpo...
Nome: Screenshot_2015-12-06_11.21.33.png
Tipo: image/png
Tamanho: 60950 bytes
Descrição: não disponível
URL: <http://lists.okfn.org/pipermail/gastosabertos/attachments/20151206/2e7203f2/attachment-0017.png>
-------------- Próxima Parte ----------
Um anexo não-texto foi limpo...
Nome: Screenshot_2015-12-06_11.21.17.png
Tipo: image/png
Tamanho: 106178 bytes
Descrição: não disponível
URL: <http://lists.okfn.org/pipermail/gastosabertos/attachments/20151206/2e7203f2/attachment-0018.png>
-------------- Próxima Parte ----------
Um anexo não-texto foi limpo...
Nome: Screenshot_2015-11-24_11.08.17.png
Tipo: image/png
Tamanho: 89446 bytes
Descrição: não disponível
URL: <http://lists.okfn.org/pipermail/gastosabertos/attachments/20151206/2e7203f2/attachment-0019.png>
-------------- Próxima Parte ----------
Um anexo não-texto foi limpo...
Nome: Screenshot 2015-12-06 11.29.00.png
Tipo: image/png
Tamanho: 45510 bytes
Descrição: não disponível
URL: <http://lists.okfn.org/pipermail/gastosabertos/attachments/20151206/2e7203f2/attachment-0020.png>