Как стать автором
Обновить

Встречают по README — что нужно знать о документации

Уровень сложностиПростой
Время на прочтение6 мин
Количество просмотров9.7K
Всего голосов 20: ↑20 и ↓0+23
Комментарии4

Комментарии 4

Редми-файл ещё ладно, а вот некоторые в txt файлы всю архитектуру детально пишут и суют в репозиторий, вот это, на мой взгляд - перебор. У нас проект из-за этого нечитаемый стал. Вначале было забавно, но потом всё больше и больше документации в проект пихали. Если код нуждается в такой документации, значит с ним что-то не так. На мой взгляд такого не должно быть - код должен быть понятен.

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

Для этого лучше подходят тесты

Ручками можно свихнуться сравнивать с тем, что в файлике

  1. Если эти тесты есть, а не пишется новый код

  2. Если тесты покрывают интересующий сценарий

  3. Если тесты правильно написаны

Зачастую ты идешь фиксить баг, когда тесты не нашли его.

Зарегистрируйтесь на Хабре, чтобы оставить комментарий