×
Reset Filters
Close
Close
Agenda

Event menu

Scroll top

Don't document your code; code your document.

11:30 - 12:00 (GMT+02:00)
10 November 2021
Keynote
Add to calendar 11/10/2021 11:30 11/10/2021 12:00 Europe/Bucharest Don't document your code; code your document. - GoTech World 2021: Revive. Rise. Accelerate the future Documentation is essential, and at the same time, it is the part of the software products that usually contain the most bugs.

Speakers:
Peter Verhas, Senior Software Engineer and Software Architect @EPAM Systems

Click here to view more details about this session.
Virtual hello@myconnector.ro aKyOfPFEVzRHclXpWmTW75232

This session has ended. Feel free to explore other areas of the event platform.

Have questions? Let's talk

Open Chat

 

Don't document your code; code your document. Documentation is essential, and at the same time, it is the part of the software products that usually contain the most bugs. For example, documentations tend to be outdated, have wrong references to the documented system, and may contain inconsistencies. The compiler or the unit tests discover the same type of errors in a program code. Documentation does not have such a compiler or tests. Writing documents, we still do assembly. The principles for high-level documentation coding are: Do not copy information from the documented system to the documentation manually. Automate your document compilation. Keep documentation source close to the system. Do not repeat yourself in the documentation, do not copy-paste text. Create unit test checking the consistency of the documentation. The talk will cover these principles and how to reach these goals using Jamal (https://github.com/verhas/jamal/), showing real-life examples. The topic was described in detail in the article https://wp.me/p37SUR-FM

Peter Verhas
Peter Verhas
Senior Software Engineer and Software Architect
EPAM Systems
rate this speaker


 

Peter Verhas is a senior software engineer and software architect with having electrical engineering and economics background (MSC and MBA). He created his first programs in 1979. Since then, he has authored several open-source programs. He has worked in several telecommunications and finance industries positions and was the CIO of the start-up index.hu during its early days. Peter works for EPAM Systems in Switzerland as a developer, supporting training programs for developers and internal mentoring. Peter is the author of several Java books published by Packt and has a blog javax0.wordpress.com You can follow Peter on https://twitter.com/verhas, https://www.linkedin.com/in/peterverhas/, https://github.com/verhas



Peter Verhas' sessions:

11:30 - 12:00 (GMT)
Nov 10, 2021
Keynote
Add to calendar 11/10/2021 11:30 11/10/2021 12:00 Don't document your code; code your document. - GoTech World 2021: Revive. Rise. Accelerate the future Documentation is essential, and at the same time, it is the part of the software products that usually contain the most bugs.

Speakers:
Peter Verhas, Senior Software Engineer and Software Architect @EPAM Systems

Click here to view more details about this session.
Virtual hello@myconnector.ro aKyOfPFEVzRHclXpWmTW75232

Don't document your code; code your document.

Documentation is essential, and at the same time, it is the part of the software products that usually contain the most bugs.


10:45 - 11:00 (GMT+02:00)
10 November 2021
Keynote
11:00 - 11:30 (GMT+02:00)
10 November 2021
Keynote
Watching
Don't document your code; code your document.
11:30 - 12:00 (GMT+02:00)
10 November 2021
Keynote
12:00 - 12:30 (GMT+02:00)
10 November 2021
Keynote
12:30 - 13:00 (GMT+02:00)
10 November 2021
Networking Break
13:00 - 13:45 (GMT+02:00)
10 November 2021
Keynote
13:45 - 14:15 (GMT+02:00)
10 November 2021
Keynote
14:15 - 14:45 (GMT+02:00)
10 November 2021
Networking Break
14:45 - 15:30 (GMT+02:00)
10 November 2021
Keynote
15:30 - 16:00 (GMT+02:00)
10 November 2021
Keynote
10:30 - 11:00 (GMT+02:00)
10 November 2021
Keynote
11:00 - 11:30 (GMT+02:00)
10 November 2021
Keynote
11:30 - 12:00 (GMT+02:00)
10 November 2021
Keynote
12:00 - 12:45 (GMT+02:00)
10 November 2021
Keynote
12:45 - 13:30 (GMT+02:00)
10 November 2021
Networking Break
13:30 - 14:15 (GMT+02:00)
10 November 2021
Keynote
14:15 - 14:45 (GMT+02:00)
10 November 2021
Keynote
14:45 - 15:15 (GMT+02:00)
10 November 2021
Keynote