Como documentar um novo projeto

raianecardoso commented 4 months ago

Pessoal,

A proposta é que comecemos a documentar os nosso projetos de maneira mais padronizada. Estas informações vão nos ajudar a estruturar melhor o projeto, as entregas, alinhar expectativas e, juntamente com outras informações, facilitar para que outras pessoas interessadas possam de informar e entender o que está sendo feito.

Por isso, todo projeto deve ter um repositório no GitHub e um issue para cada robô. Isto é parte do que chamamos de marco inicial do projeto, que também inclui as reuniões com os stakeholders do projeto para alinhamento de expectativas e a inserção das informações do projeto na nossa base de dados.

Gostaria da colaboração de vocês para pensarmos juntos nas modelo padrão desse issue a partir da proposta abaixo:

Documentação: Issue do Robô

Nome do Robô: nome que identifica o robô, idealmente igual ao informado no banco de dados.

Responsável: pessoa da equipe responsável pelo robô.

Contexto: texto que explica de maneira geral o processo que o robô irá atuar. Idealmente, neste tópico deverá contar um o desenho do fluxo atual (as is), identificando as partes envolvidas e macro ações.

Proposta de robô: descrição das ações que serão executadas pelo robô. Idealmente, neste tópico deverá contar um o desenho como ficará o fluxo do processo (to be), identificando as partes envolvidas e macro ações. Além disso, nesse tópico podem ser apontadas outras alterações no fluxo inicialmente identificadas que serão necessárias para o desenvolvimento do projeto.

A ferramenta para desenho do processo pode ser eleita pelo responsável a depender do nível de detalhamento do processo.

Requisitos: descreve o que será necessário para o desenvolvimento e funcionamento do robô, como chaves de acesso (cpf, masp, etc), origem dos dados, artefatos e sistemas que serão usados (planilha, terminal prodemge, sei).

Limites e não escopo: define o que não está no escopo do projeto, bem como descreve fatores que restringem a atuação da equipe no projeto.

gabrielbdornas commented 4 months ago

A ferramenta para desenho do processo pode ser eleita pelo responsável a depender do nível de detalhamento do processo.

@automatiza-mg/dcd, tem uma ferramenta que gosto muito para desenho de fluxos que chama Mermaid.Js. Ela é ótima para fluxos rápidos, integrada no Markdown, e pode ser desenhada dentro desta mesma caixa de comentários do Issue do GitHub. Exemplinho rápido de como funciona:

flowchart TD
    A[Christmas] -->|Get money| B(Go shopping)
    B --> C{Let me think}
    C -->|One| D[Laptop]
    C -->|Two| E[iPhone]
    C -->|Three| F[fa:fa-car Car]

Se quiserem, podemos fazer um webnar sobre isso!

Andrelamor commented 4 months ago

A ferramenta para desenho do processo pode ser eleita pelo responsável a depender do nível de detalhamento do processo.

@automatiza-mg/dcd, tem uma ferramenta que gosto muito para desenho de fluxos que chama Mermaid.Js. Ela é ótima para fluxos rápidos, integrada no Markdown, e pode ser desenhada dentro desta mesma caixa de comentários do Issue do GitHub. Exemplinho rápido de como funciona:
flowchart TD
    A[Christmas] -->|Get money| B(Go shopping)
    B --> C{Let me think}
    C -->|One| D[Laptop]
    C -->|Two| E[iPhone]
    C -->|Three| F[fa:fa-car Car]
Se quiserem, podemos fazer um webnar sobre isso!

@gabrielbdornas escelente ideia, o Mermaid pode deixar mais prática essa tarefa, também já usei para um dos projetos - exemplo aqui

gabrielbdornas commented 4 months ago

@gabrielbdornas escelente ideia, o Mermaid pode deixar mais prática essa tarefa, também já usei para um dos projetos - exemplo aqui

Docs as code na veia!!!

raianecardoso commented 3 months ago

Sugestões Webnar 10 (26.jul)

Cada projeto, é um repositório. Dentro de um projeto, podemos ter mais de um processo e de um robô. Esses processos e robôs viram um issue dentro desse repositório. Além disso, dentro desse repositório, poderão ter outros issues relacionados com projeto, como o registro de reuniões.
Para primeiros contatos, antes de uma demanda virar projetos, as reuniões e tarefas relacionadas as demandas podem ser registradas no repositório do núcleo de imersões.
Padronizado: nome repositório: SiglaDoÓrgão-SiglaDaSubsecretaria OU SiglaDaSuperintendencia OU NomeDoProjeto

__

Tarefas para @gabrielbdornas e @raianecardoso :

[ ] Padronizar o nome do issue do robô;
[ ] Estudar modelos e criar Issue Template para robô;
[ ] Criar post para orientar equipe. __

@automatiza-mg/dcd, faltou algo?

automatiza-mg / handbook