Что такое документация кода

Документация — это описание того, как устроена и как работает программа. Разберём, зачем она нужна и какой бывает.

Простыми словами

Документация кода — это пояснения к программе: что она делает, как её запустить и как ею пользоваться. Её читают люди, а не компьютер.

Это как инструкция к технике: сама техника работает и без чтения, но с инструкцией разобраться быстрее.

Комментарии в коде поясняют отдельные места. Файл README рассказывает о проекте целиком. Отдельно описывают, как пользоваться функциями и программой.

Уровни разные, но цель одна — чтобы было понятно.

Без документации даже автор через полгода забудет, как всё работает. А новому человеку в проекте без неё разобраться очень тяжело.

Хорошее описание экономит команде часы на вопросах и догадках.

Коротко и по делу: что делает, как запустить, какие есть особенности. Важнее пояснять «почему так сделано», а не пересказывать очевидный код.

Документацию обновляют вместе с кодом, иначе она начинает врать.

Это обязательно? Для серьёзного проекта — да, хотя бы короткий README.

С чего начать новичку? Пишите понятные комментарии к своим программам — даже к простым, вроде тех, что пишете в «Дрон Кодере».