Automating documentation on JavaScript projects
Please log in to watch this conference skillscast.
Documenting code is an important task that few teams get right. Docs get easily outdated, everybody hates writing them and sometimes developers don’t even use them at all.
In this talk, you will learn about an approach to documentation writing based on adding comments directly to the source code. Marcos will show you its benefits applied to three different types of codebases.
You will also learn how to generate documentation from those same comments in two different flavors as well as when each of them work best.
YOU MAY ALSO LIKE:
- Performance Budgets: The What, Why And How (SkillsCast recorded in July 2018)
- Damjan Vujnovic's Advanced JavaScript Workshop (in London on 4th - 6th November 2019)
- Damjan Vujnovic's Angular Workshop (in London on 25th - 27th November 2019)
- P3X - People, Product & Process eXchange 2019 (in London on 31st October - 1st November 2019)
- FullStack NYC 2020 - The Conference on JavaScript, Node & Internet of Things (in New York on 14th - 15th May 2020)
- Keynote by Luca Mezzalira on Demystifying Micro-Frontends (in London on 23rd September 2019)
- Inspire creation with technology such as the Raspberry Pi over a pint. (in London on 24th September 2019)
- When Graph Visualisation Goes Wrong - Some Pitfalls and How to Avoid Them (SkillsCast recorded in September 2019)
- Visualising Knowledge Graphs (SkillsCast recorded in September 2019)
Thanks to our sponsors
Automating documentation on JavaScript projects
Marcos Iglesias Valle
Marcos Iglesias is a Senior Software Engineer who builds compelling user interfaces at Eventbrite. Marcos is passionate about improving web performance, setting performance budgets and tracking them because "web performance matters!" On top of all that, he enjoys writing about software, giving talks and maintaining Britecharts, the open source charting library.
Please log in to watch this conference skillscast.
Documenting code is an important task that few teams get right. Docs get easily outdated, everybody hates writing them and sometimes developers don’t even use them at all.
In this talk, you will learn about an approach to documentation writing based on adding comments directly to the source code. Marcos will show you its benefits applied to three different types of codebases.
You will also learn how to generate documentation from those same comments in two different flavors as well as when each of them work best.
YOU MAY ALSO LIKE:
- Performance Budgets: The What, Why And How (SkillsCast recorded in July 2018)
- Damjan Vujnovic's Advanced JavaScript Workshop (in London on 4th - 6th November 2019)
- Damjan Vujnovic's Angular Workshop (in London on 25th - 27th November 2019)
- P3X - People, Product & Process eXchange 2019 (in London on 31st October - 1st November 2019)
- FullStack NYC 2020 - The Conference on JavaScript, Node & Internet of Things (in New York on 14th - 15th May 2020)
- Keynote by Luca Mezzalira on Demystifying Micro-Frontends (in London on 23rd September 2019)
- Inspire creation with technology such as the Raspberry Pi over a pint. (in London on 24th September 2019)
- When Graph Visualisation Goes Wrong - Some Pitfalls and How to Avoid Them (SkillsCast recorded in September 2019)
- Visualising Knowledge Graphs (SkillsCast recorded in September 2019)
Thanks to our sponsors
Automating documentation on JavaScript projects
Marcos Iglesias Valle
Marcos Iglesias is a Senior Software Engineer who builds compelling user interfaces at Eventbrite. Marcos is passionate about improving web performance, setting performance budgets and tracking them because "web performance matters!" On top of all that, he enjoys writing about software, giving talks and maintaining Britecharts, the open source charting library.