Програмирование и документация?

Есть вопрос по поводу документации в проекте.


Многие пишут о том что должна по идее существовать документация для разработчиков и для пользователей.


и обе эти документации вытекают из грамотно наисанного кода.


для разработчиков я так понимаю это исходя из комментариев и оформления кода, можно генерировать тем же phpdoc а что касается юзерской документации это как?


что вообще необходимо соблюдать что б проект в меньшей степени зависил от конкретного разработчика?

т.е. при смене девелопера, новый человек без (или с минимальной) помощи предыдущего сотрудника, смог влиться в проект?
  • Вопрос задан
  • 2733 просмотра
Пригласить эксперта
Ответы на вопрос 3
lybin
@lybin
looking for remote full time job python backend
habrahabr.ru/qa/5968/ — для разработчиков, в итоге приобрели Confluence
Ответ написан
pratamishus
@pratamishus
Насчет юзерской документации — я всегда просто писал сам. Муторно, но надо. Просто используете некоторые основные скриншоты и пишете в каком-нибудь ворд документе.

Насчет смены девелопера — просто используйте общепринятые стандарты программирования. Используйте ООП и технику системного анализа (UML, ClassDiagram и т.п.). С другой стороны, некоторые говорят, общих стандартов не существует и в этом есть истина :). Для этого просто берете самую популярную книгу по программированию в определенном языке (например в PHP книгу Люка Веллинга и Лауры Томсон «Веб разработка в РНР и MySQL — Luke Welling and Laura Thomson — PHP and MySQL Web Development) и придерживаетесь их принципов.

В остальном новый разработчик уже должен сам разобраться. Если код написан хорошо и структурно, то для нормального девелопера не составит сложности все понять. Тем более, если Вы пишете документацию.
Ответ написан
super
@super
Документация пользователя и интерфейс приложения должны быть единым целым, нет никаких причин их разделять.
Ответ написан
Ваш ответ на вопрос

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

Войти через центр авторизации
Похожие вопросы