powered by simpleCommunicator - 2.0.36     © 2025 Programmizd 02
Форумы / Управление процессом разработки ИС [игнор отключен] [закрыт для гостей] / Документация проекта
6 сообщений из 6, страница 1 из 1
Документация проекта
    #36329731
bagos
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Здравствуйте, формучане:)
Хотел поинтересоваться кто как оформляет свои проекты, как документирует и т.д. и т.п.
Какой должен быть состав документов, чтобы можно было разобаться в структуре программы ее алгоритмах( т.к. через год-другой все забудеться, по клачкам бумажек восстановить всю картину бывает проблематично).
Я представляю себе так : ТЗ, блок схемы, описание, исходный код.
Буду очень признателен за любую полезную информацию!
...
Рейтинг: 0 / 0
Документация проекта
    #36330338
ЮВ
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
bagos
Какой должен быть состав документов, чтобы можно было разобаться в структуре программы ее алгоритмах

Состав и содержание документации на программные средства определяют ГОСТы группы 19,
на информационные системы - ГОСТы группы 34.
...
Рейтинг: 0 / 0
Документация проекта
    #36330391
egorych
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
bagos,
рекомендую посмотреть в сторону систем автоматической генерации документации по исходному коду, такие как javadoc или doxygen.
Если проект формальный, и необходимо следовать ГОСТам, то рекомендация ЮВ - самое оно
...
Рейтинг: 0 / 0
Документация проекта
    #36331895
ЮВ
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
egorychЕсли проект формальный, и необходимо следовать ГОСТам

Ну, а если неформальный, то можете воспользоваться книгой В. В. Липаева "Документирование сложных программных средств", в которой приведено описние шаблонов десятков самых разнообразных программных документов.
...
Рейтинг: 0 / 0
Документация проекта
    #36332993
egorych
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
ЮВ,

в неформальном проекте никто не будет писать, и самое главное, поддерживать, десятки разных программных документов, к сожалению. В этом беда неформальных проектов, имхо
...
Рейтинг: 0 / 0
Документация проекта
    #36333584
Фотография alexeyvg
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
egorychЮВ,

в неформальном проекте никто не будет писать, и самое главное, поддерживать, десятки разных программных документов, к сожалению. В этом беда неформальных проектов, имхо"Формальный" - это говорится про документацию, которую делают потому, что положено.

Качественная документация появляется тогда, когда она нужна, а не тогда, когда заставили делать по госту.

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


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