How to Write Technical Documentation and Code (And Don’t Make Mistakes)

Purpose: Emphasize the importance of mindfulness and literacy in the engineering profession. The work of a programmer is not only writing code, but also creating high-quality technical documentation. The way you frame your thoughts, specifications and comments speaks to your professionalism as much as the ability to build an application architecture. The purity of code starts with the little things. The devil is in the details. When reviewing projects, teachers and team leaders pay attention to everything from directory structure to variable names. An offensive typo – for example, written hastily by Puth instead of the correct Path when configuring routing or paths in the file system – can not only ruin the impression, but also break the build of the entire project at the most inopportune moment. Respect for colleagues Technical documentation is not written for machines, it is written for people. When you work as a team, dozens of other engineers will read your code. Teach yourself from the first laboratory work to leave clear comments, describe the logic of the API and monitor the literacy of the text. The ability to describe technical processes clearly, without slang or errors is a critically important Soft Skill. It allows you to easily pass the code review and successfully pass projects to customers, without spending hours looking for stupid typos.