powered by simpleCommunicator - 2.0.51     © 2025 Programmizd 02
Форумы / Разработка информационных систем [игнор отключен] [закрыт для гостей] / Чье ремесло писать проект комплектной документации ?
5 сообщений из 5, страница 1 из 1
Чье ремесло писать проект комплектной документации ?
    #36181885
Han Yuriy
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Добрый день! Во всех методологиях разработки программного обеспечения существует понятие документация, где "живая" а где "не живая". Довольно часто наблюдаю картину как пара программистов-разработчиков, параллельно написанию кода тщетно пытаются связать слова в более менее ясный документ, именуемый Проектной документацией.
Объясните мне, кто по праву и обязанности должен выполнять эту работу? Кто, точнее, специализируется на этом? Кого нужно привлекать к такого рода работам?
Большое спасибо!
...
Рейтинг: 0 / 0
Чье ремесло писать проект комплектной документации ?
    #36183148
905
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Han Yuriy,

программист обязан четко и ясно делать комментарии к коду (классы, методы, особенности реализации)
можно оформить комментарии для авто-генерации докумендации через doxygen, что будет полезно для составления таких документов как "описание программы" и т.п.
никто кроме программиста не напишет содержание руководства оператора к своей программе, оформлять же лучше отдать другому человеку (можно использовать wiki движки для автоматизации)
...
Рейтинг: 0 / 0
Чье ремесло писать проект комплектной документации ?
    #36183842
ЮВ
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Han Yuriy...Объясните мне, кто по праву и обязанности должен выполнять эту работу?

Есть такая специальность - технический писатель (разработчик документации).
...
Рейтинг: 0 / 0
Чье ремесло писать проект комплектной документации ?
    #36183997
Фотография shelsoft
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
ЮВЕсть такая специальность - технический писатель (разработчик документации).
Гм .. как исполняющий роль бизнес и системного аналитика по своему направлению пишу
1) Спецификацию на ПО
2) Требования
3) Решения по архитектуре и основные алгоритмы
Потом это все отправляется техпису который формирует уже проектную документации. По моему опыту при не типовых решениях решениях или при сильной кастомизации выделенный техпис не способен в приемлимые для проекта сроки описать именно решение. Кроме это написание ключевых моментов доки позволяет еще раз провести трассировку решения.
Резюме: внятно-понятное описания ключевых моментов системы бизнес-процесса и построения системы (не вдаваясь в код) лежит на бизнес и системном аналитике (архитекторе) как носителей "гениальных идей"
...
Рейтинг: 0 / 0
Чье ремесло писать проект комплектной документации ?
    #36184545
ЮВ
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
shelsoftРезюме: внятно-понятное описания ключевых моментов системы бизнес-процесса и построения системы (не вдаваясь в код) лежит на бизнес и системном аналитике (архитекторе) как носителей "гениальных идей"

Да, на стадии технического проекта, когда принимаются основные решения по будущей системе, описать их может только автор этих решений (а техпис оформить, если требуется, в соответствии со стандартами).

Но автор письма пишет

авторпара программистов-разработчиков, параллельно написанию кода тщетно пытаются связать слова в более менее ясный документ, именуемый Проектной документацией.

Т.е.на стадии программирования проект уже есть (хотя бы в голове) и работа по нему ведется.
Тогда для чего (для отчетности?) нужно писать документацию на пройденный этап?
Или программисты пишут все-таки эксплуатационную документацию?
Написать эксплуатационную документацию (особенно на прикладные системы с графическим интерфейсом) техпис должен быть способен.
А по эксплуатационной документации, при необходимости, можно написать и проектную
(пост фактум).
...
Рейтинг: 0 / 0
5 сообщений из 5, страница 1 из 1
Форумы / Разработка информационных систем [игнор отключен] [закрыт для гостей] / Чье ремесло писать проект комплектной документации ?
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]