Contemporary Documentation - HelsinkiJS
0 likes
views
Check these out next
Contemporary Documentation - HelsinkiJS
0 likes
views
One of the critique most vocal opposition of code comments use online, is that code comments become outdated and thus harmful. Code comments are a great way to store very specific information of functions, hacks and decisions that gets lost over time. We often talk about documentation in two forms: either code comments that live with the code or readmes, API docs and other more curated written documentation. But both of them suffer from lack of history. But there’s more! We often look back at decisions without having the understanding and knowledge of that moment and criticize the code or decisions made hastily. But almost always, decisions are made using the best understanding and knowledge (and restrictions of reality) of that particular moment in time. In this talk, I’ll explore how you can use issue tracker tickets, git commits and pull requests as a contemporary documentation: something that tells us about the world as it was when decisions were made and that doesn’t change as the project moves on. -- This version of the talk was given in HelsinkiJS on September 24th, 2019
Recommended
Contemporary Documentation - HelsinkiJS
- CONTEMPORARY DOCUMENTATION HelsinkiJS • Juha-Matti Santala • September 24th 2019
- CONTEMPORARY /kənˈtɛm.pəˌɹɛɹ.i/ 1. From the same time period, coexistent in time. 2. Modern, of the present age @hamattiHelsinkiJS
- HI, I’M JUHIS Developer Community & Web Dev @ Futurice Founder of Turku <3 Frontend Background in startups & consulting @hamatti in Twitter from Helsinki, ! @hamattiHelsinkiJS
- @hamatti TEAMS CHANGE HelsinkiJS
- DOCUMENTATION SHOULD @hamatti PROVIDE CONTEXT HelsinkiJS
- (MOST OF THE) DOCUMENTATION IS A LIVING ORGANISM @hamatti (README, API DOCS, CODE COMMENTS) HelsinkiJS
- COMMIT MESSAGES @hamatti CODE REVIEW STORIES & TASKS 3 BRANCHES HelsinkiJS
- @hamatti It’s hard because the reward comes later HelsinkiJS
- COMMIT MESSAGE @hamattiHelsinkiJS
- @hamatti https://xkcd.com/1296/ HelsinkiJS
- @hamatti “What would you like to know two years from now?” HelsinkiJS
- @hamatti “What would you ask from a colleague who wrote this two years ago?” HelsinkiJS
- @hamattihttps: //chris.beams.io/posts/git-commit/HelsinkiJS
- CODE REVIEW @hamattiHelsinkiJS
- https://github.com/facebook/react/pull/16302
- WRITE IT DOWN @hamatti ASK A LOT OF QUESTIONS DON’T DELETE COMMENTS HelsinkiJS
- STORIES & TASKS @hamattiHelsinkiJS
- STORIES & TASKS @hamatti Origin / Business Driver How to reproduce? Definition of Done Clarifying questions HelsinkiJS
- WRITE IT DOWN @hamattiHelsinkiJS
- @hamattiHelsinkiJS
- @hamattiHelsinkiJS
- @hamattiHelsinkiJS
- @hamattiHelsinkiJS
- @hamattiHelsinkiJS
- @hamattiHelsinkiJS
- RECAP @hamatti COMMIT MSG, CODE REVIEW & ISSUES “WHAT WOULD I WANT TO KNOW IN 2 YEARS” WRITE IT DOWN HelsinkiJS
- @hamatti twitch.tv/hamatti Django + React 28th September 2019 OPEN SOURCE IN TWITCH HelsinkiJS
- @hamatti Dev Breakfast - newsletter for software developers Sign up @ hello.futurice.com/dev-breakfast HelsinkiJS
- THANK YOU! @hamatti @hamatti https://hamatti.org juhis@futurice.com webbidevaus.fi/56 futurice.com/careers (PS. We are hiring!) HelsinkiJS