Задать вопрос
hol
@hol
¯\_(ツ)_/¯

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

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

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

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

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

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

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

Похожие вопросы