transparencia-mg / handbook

Manual interno de operação da Diretoria de Transparência Ativa
https://transparencia-mg.github.io/handbook/
MIT License
0 stars 1 forks source link

Repositório para armazenamento de tarefas intensivas em pesquisa #19

Open fjuniorr opened 2 years ago

fjuniorr commented 2 years ago

Tarefas intensivas em pesquisa e que não produzem uma entrega tangível (eg. leitura de um termo de referência, pesquisa sobre UI design patterns para tabelas, pesquisa sobre mocking em testes unitários, pesquisa sobre licenças de dados) possuem pouca visibilidade para atores externos.

Como forma de fonte de comprovação, e, ao mesmo tempo, como forma de organização do corpo de conhecimento gerado pelos servidores da DTA durante a elaboração dessas tarefas vamos criar um repositório de notas de pesquisa, no estilo Zettelkasten.

@gabrielbdornas acho que usamos uma estrutura diferente, tanto de nomes de arquivos quanto de conteúdo. Vamos harmonizar isso para criarmos o da DTA.

Meu padrão atual é:

notebook/
notebook/README.md
notebook/notes/20211019T140813.md
notebook/notes/20211026T190131.md
notebook/notes/20211019T140836.png # imagens também são armazenadas com timestamps na pasta notes/

E o único conteúdo obrigatório da nota notebook/notes/20211019T140813.md é um título com # e wikilinks no estilo da Wikipedia com [[ ]]

# titulo da nota

Lorem ipsum dolor sit amets. Vide [[20211026T190131]] para mais detalhes. 

Ou a imagem abaixo

![](20211019T140836.png)

Compartilha o seu padrão para escolhermos o da DTA.

gabrielbdornas commented 2 years ago

@fjuniorr, perfeito. Eu utilizo a extenção sublime_zk e ela já faz praticamente tudo.

O padrão de nomenclatura dos arquivos é timestamp titulo.md, a saber:

Como exemplo:

notes/20210122 titulo da nota.md

Se bem me lembro é possível configurar outros padrões de nomenclatura na extenção.

O conteúdo obrigatório das notas também pode ser configurado na extenção, não tendo um padrão fixo. O que eu escolhi utilizar foi:

---
ID: <criado-automaticamente>
Título:  <criado-automaticamente> 
Autor:  <criado-automaticamente>
data:  <criado-automaticamente>
tags: 
---

 <titulo>
===

## Conteúdo

## Referências

Por fim, wikilinks no estilo da Wikipedia com [[ ]] também são aceitos.