Documentação em toda parte

beatrizoliveira

Beatriz Oliveira

Posted on February 19, 2024

Documentação em toda parte

Nesse texto irei comentar como o ato de documentar interfere na minha vida em vários aspectos e como você também pode utilizar e se beneficiar.

No Trabalho

Eu pessoalmente estou sempre adepta a usar documentação para explicar fluxos importantes tanto tecnicamente quanto sobre regra de negócios de uma empresa ou organização em que você esteja trabalhando.

A documentação no serviço te ajuda a andar mais rápido e não ter muitas dependências externas.

Por exemplo: Não sei o fluxo de algo, não domino aquilo ---> vou na doc (interna ou externa) ---> e me destravo sem precisar chamar alguém da equipe para me ajudar naquilo que já foi documentado e consequentemente parar a pessoa para tal.

Fluxo de documentação

Muitas vezes há lacunas nessas documentações ou até nem existe uma dependendo do local. É importante que você seja proativo em criá-las, isso irá ajudar a todos.

Uma dica do "o que" documentar além do genérico "fluxos importantes e regras de negócios" é quando chega em você mais de 1 vez a mesma pergunta: "Como é mesmo que funciona aquilo?", isso já é um indicativo que pode ser documentado.

Em resumo te ajuda a não ter trabalho repetitivo, além de descentralizar conhecimento com seu time.

Vida

O tópico acima pode ser utilizado também na questão vida em uma explicação mais genérica, mas aqui irei comentar minha visão e como me ajuda no dia-a-dia.

Finanças

É de conhecimento ou deveria ser que ter uma planilha de acompanhamento financeiro seja de alta importância principalmente na vida adulta, e olha só também é uma forma de documentação!

Estudos

Nos estudos a documentação pode aparecer de diversas maneiras, com resumos, artigos, vídeos explicativos, anotações. Eu particularmente gosto de escrever meus aprendizados e compartilhar em algum lugar para outras pessoas (é uma forma num alto nível de descentralizar conhecimento em massa).

Diário

Também gosto bastante da documentação diária através de um caderno apenas para isso, me ajuda a organizar pensamentos, analizar de fora como foi o dia, e resolucionar problemas organizar rotina ou planejar (agenda).

Performance

Por último mencionar performance, seja de alguma meta que você queira alcançar ou talvez comparar o seu eu do passado com o de agora, só podemos ter uma visão concreta do progresso ou degresso com algo concreto e palpável como por exemplo alguma forma documentada disso.

https://twitter.com/biantris_/status/1504158969606062084
Twitter quote

Para finalizar esse texto vale pontuar que existe inúmeras maneiras de documentar algo seja ela: textual, visual, através de audio, etc. O importante é conseguir fazer o ato de documentar para destravar sua vida e as dos outros ou apenas se expressar.

Um artista também doucumenta a expressão dos seus vários eu's durante o tempo.

Trecho do livro O ato criativo: Uma forma de ser
Trecho do livro O ato criativo: Uma forma de ser

Obrigado quem leu até aqui e espero que esse post tenha lhe agregado em algo na sua trajetória \o/

Foto de Aaron Burden na Unsplash


Qualquer dúvida só mandar DM no Twitter @biantris
Se quiser continuar apoiando meus conteúdos Patreon
Meu GitHub biantris

💖 💪 🙅 🚩
beatrizoliveira
Beatriz Oliveira

Posted on February 19, 2024

Join Our Newsletter. No Spam, Only the good stuff.

Sign up to receive the latest update from our blog.

Related

Documentação em toda parte
documentation Documentação em toda parte

February 19, 2024