Господа программеры, заставляют ли вас на работе...?

программы работа документы

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


PS не люблю я это дело :(
Ответы:
У нас не заставляют, а зря... Потом с такой херью написанной другими сталкиваешься, что лучше бы уж документацию писал... и читал, вон у нас в системе поддержки полфункционала в одном файле... причём написавший эту муть года как три уволился, а я до сих пор XSS-ы нахожу.
Хреновая та прога к которой не доков. Или пишите так чтоб ее не потребовалось (1 кнопка)
Да, так как это неотъемлемая часть процесса разработки ПО. Под написанием документации в данном случае я имею ввиду:
1. Составление требований к системе на основании требований заказчика
2. Написание прецедентов (Use Cases)
3. При разработке архитектуры - диаграммы классов, последовательности, взаимодействия, ER-диаграммы (если есть БД) с подробными комментариями.
4. Куча сопутствующих документов - взаимосвязи между отдельными частями ПО, используемые данные, возможные значения определенных параметров
5. Подробное комментирование кода (на основании комментариев потом автоматом генерируется документация) - назначение классов, свойств, методов и их параметров, зависимости
Естественно что не все члены команды пишут каждый документ, но обязательно проводится peer review с их участием по каждой новой ревизии документа.
На все то выделяется время в плане проекта, причем не маленькое.
В результате сам процесс разработки становится довольно простым. Удается избежать многих сложностей - не приходится менять архитектуру в конце проекта или судорожно добавлять новую функциональность. Кроме того упрощается поддержка, не возникает проблем если поддержкой придется заниматься людям, не участвовашим в разработке.
з.ы. если же Вы имели ввиду составление руководства пользователя - то для этого есть специальные люди (которые в крайнем случае будут просто консультироваться с программистами)
нет, документацию пишут тех. писатели. Используемые алгоритмы и соглашения описывают либо программисты либо постановщик задачи.
Понятно желание начальства в том чтобы код существовал независимо от его автора.
И понятно нежелание писать документацию ибо "job security".
Нас не заставляют. Пытаюсь убедить начальство, что это жизненно необходимо. Так что радуйся, иначе бывает гораздо хуже, поверь мне.
Комментарии в коде и техноты мы и сами с удовольствием. А вот когда нас (программеров) заставили писать техзадание и техпроект по ГОСТам - вот это была жесть...
У нас не пишут. И это не есть гуд - зачастую приходится вызванивать коллег, которые уже не коллеги и в срочном порядке спрашивать что и где. Сам стараюсь по максимуму комментировать код.


17 лет назад

RPI.su - самая большая русскоязычная база вопросов и ответов. Наш проект был реализован как продолжение популярного сервиса otvety.google.ru, который был закрыт и удален 30 апреля 2015 года. Мы решили воскресить полезный сервис Ответы Гугл, чтобы любой человек смог публично узнать ответ на свой вопрос у интернет сообщества.

Все вопросы, добавленные на сайт ответов Google, мы скопировали и сохранили здесь. Имена старых пользователей также отображены в том виде, в котором они существовали ранее. Только нужно заново пройти регистрацию, чтобы иметь возможность задавать вопросы, или отвечать другим.

Чтобы связаться с нами по любому вопросу О САЙТЕ (реклама, сотрудничество, отзыв о сервисе), пишите на почту [email protected]. Только все общие вопросы размещайте на сайте, на них ответ по почте не предоставляется.