Задать вопрос
hol
@hol
¯\_(ツ)_/¯
веб-разработка

Когда Вы пишете документацию к проекту?

Важно: Речь идёт не о документации в коде, а обо всём проекте в целом(как использовать, как настраивать)

Есть два варианта:

В процессе написания:
Пишете доки совместно с кодом описывая каждую мелочь. Если какая то фича изменится Вы будете переписывать документацию.

После написания проекта:
Вы тщательно приходитесь по готовому проекту, познаёте дзен и садитесь писать доки.

P. S. Желательно аргументировать своё мнение...
  • Вопрос задан
  • 542 просмотра
Комментировать
Подписаться 2 Оценить Комментировать
Решения вопроса 1
webinar
@webinar Куратор тега Веб-разработка
Учим yii: https://youtu.be/-WRMlGHLgRg
Документация не только для галочки, но и Вам в помощь, а значит второй вариант просто идиотизм. Если проект большой, к моменту его окончания Вы просто хрен вспомните что тот или иной метод делает. Так что только первый вариант. Второй допустим, если это очень маленький проект и документация тупо для галки.
Я уже молчу, что правильная документация и современная IDE помогают в процессе тупо автокомплитами и быстрой навигацией.
Ответ написан
Комментировать
Комментировать
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы
Вакансии с Хабр Карьеры
Веб-разработчик
Искра • Екатеринбург
от 80 000 до 100 000 ₽
Веб-разработчик
Art gorka • Санкт-Петербург
от 60 000 ₽
Веб-дизайнер
Stakewolle
от 40 000 до 60 000 ₽
Ещё вакансии
Заказы с Хабр Фриланса
Доработать телеграм бота
19 апр. 2024, в 03:52
1000 руб./за проект
Написать код на python
19 апр. 2024, в 03:01
1000 руб./за проект
Настройка сервера
18 апр. 2024, в 21:56
2000 руб./за проект
Ещё заказы