Java User Group Switzerland
Postfach 2322 • 8033 Zürich
info@jug.ch • www.jug.ch
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
Mastodon: @verhas@c.im
X (former Twitter): @verhas
16.11.2023
Don't document your code; code your document.
LOCATION: Luzern
| AGENDA: | 18:15-19:30h: Talk incl. Q/A After a (hopefully) interesting talk, you will have the opportunity to exchange ideas and network with the speaker and professional colleagues over beer, wine and rich finger foods. |
SPEAKER: Peter Verhas COMPANY: EPAM Systems
Documentation is essential, and at the same time, it is 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 sources close to the system.
- Do not repeat yourself in the documentation, and do not copy-paste text.
- Create unit tests 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.
LANGUAGE: Talk: en / Slides: en
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
Mastodon: @verhas@c.im
X (former Twitter): @verhas
Supporting members
Platin
Gold
Silver
About
JUG Switzerland aims at promoting the application of Java technology in Switzerland.
JUG Switzerland facilitates the sharing of experience and information among its members. This is accomplished through workshops, seminars and conferences. JUG Switzerland supports and encourages the cooperation between commercial organizations and research institutions.
JUG Switzerland is funded through membership fees.
Design
Partner
