14. Consolidação da documentação

Por todo esse percurso, temos reforçado a necessidade da prática de documentar todas as decisões e escolhas de forma clara e recorrente.

Sugerimos que essa tarefa não seja realizada de forma separada do restante da pesquisa. O ato de documentar concomitantemente à pesquisa possibilita que o registro se torne mais detalhado, consciente e completo. Permite que o pesquisador e outros interessados possam acompanhar cada etapa metodológica e como ela dialoga com as reflexões teóricas.

Permite também a reprodutibilidade da pesquisa, sua avaliação e apresentação.

Propomos que na etapa final, seja realizada uma revisão detalhada da documentação produzida, padronizando seus ficheiros, revendo a escrita, fornecendo links e referências adequadas.

Lembrar que a documentação dever ser elaborara pensando em possibilitar que outros pesquisadores possam compreender e reproduzir a pesquisa. Portanto, seja o mais explicito e detalhista possível.

Reveja se todos os diretórios de sua pesquisa possuem um README.md, contendo uma descrição sumária do conteúdo do diretório, com links apontando para cada ficheiro ou subdiretório.

Reveja se os ficheiros possuem cabeçalhos com metadados padronizados, como título, autor, data de criação, data de modificação, licença, entre outros.

Reveja se os scripts possuem comentários que expliquem o que está sendo feito em cada linha de código.