p de Podcast podcast

Código como Documentação

26/02/2021
0:00
56:18
Recuar 15 segundos
Avançar 15 segundos

Qual a documentação necessária pro sistema? O código fonte é o suficiente? Conhece 'código como documentação'? Vem trocar ideia com a gente.


Participantes


Marcio Frayze David
[email protected]
https://twitter.com/marciofrayze
https://segunda.tech
https://masto.donte.com.br/web/accounts/138458
https://linkedin.com/in/marcio-frayze


Julianno Martins Silva
[email protected]
https://twitter.com/juliannoms
https://linkedin.com/in/juliannoms


Links:

Artigo do Fowler:

https://www.martinfowler.com/bliki/CodeAsDocumentation.html


Artigos do Jack Reeves recomendados pelo Fowler:

https://www.developerdotstar.com/mag/articles/reeves_design.html

https://www.developerdotstar.com/mag/articles/reeves_13yearslater.html

https://www.developerdotstar.com/mag/articles/reeves_originalletter.html


Spring REST Docs:

https://spring.io/projects/spring-restdocs


Vídeo da Punk do DevOps falando sobre padrões nas mensagens de commit:

https://www.youtube.com/watch?v=vXOVl6TxuOE&t=388s


Outra convenção para mensagens de commit:

https://www.conventionalcommits.org/pt-br/v1.0.0/


Mais uma convenção para mensagens de commit:

https://karma-runner.github.io/6.1/dev/git-commit-msg.html


Artigo contrário à nossa ideia, com baixa abstração:

https://medium.com/it-dead-inside/self-documenting-code-is-mostly-nonsense-1de5f593810f

Mais episódios de "p de Podcast"