Поставка прог. продукта заказчику. Что использовать ISO, ГОСТ ?

← →
Fellomena (2002-05-13 18:51) [0]

Всем привет! Есть тех. задание на разработку программного продукта. Сам программный продукт разработан. В тех. задании сказано, что продукт должен быть типа open source, т.е. исходники со всеми вытекающими должны поставляться.
Вопрос: каково содержание, последовательность и т.д. оформления "сопроводиловки"?
Прог. продукт смешанного типа, т.е. процедурно-объектный. Что кроме диаграммы классов, входных/выходных параметров для процедур/функций, поверочных расчётов и оценки погрешности я должна предоставить. Как всё это дело описать?
Использовать наш ГОСТ не предстовляется целесообразным, т.к. он устарел на 20 лет, а ISO 15910:1999 найти не получается в INet-е.

Подскажите plz...

← →
Дмитрий Баранов (2002-05-13 19:26) [1]

Подойти творчески и взять за образец документацию всеми любимого гиганта софтверной индустрии (SDK, API, Knowledge base :) Но это имхо :) Ну в крайнем случае мануалы соорудите... консольные... a la Free BSD какой-нить ... OpenSourc`овей не придумаешь. Чем не образец?

← →
Fellomena (2002-05-13 19:33) [2]

2 Дмитрий Баранов:
А Вы о "Пользовательской документации программных средств" слышали? Тут одним творчеством не отделаешься. А SDK - это не тех. документация на Windows, прошу заметить, а всего лишь help.
Про FreeBSD и иже с ним и говорить не стоит, т.к. все спецификации должны в твёрдой копии быть => иметь соответствующее обрамление, оформление и т.д.

← →
limon © (2002-05-13 22:18) [3]

Сочувствую, жаль, помочь не могу. :-(

← →
ShaggyDoc © (2002-05-14 07:31) [4]

Глубокоуважаемая Fellomena, Вы крепко влипли! Как оформлять сопроводительную документацию, надо было точно оговаривать в упоминающемся тех. задании. Заодно надо было и требовать, чтобы техзадание (если, конечно, за его подготовку Вы не срубили бабки) смо соответствовало некоему стандарту.

Составление документации - ловушка, в которую часто попадаются даже стреляные воробьи. Занимает времени в 2-4 раза больше, чем написание программы. А программный продукт, который у Вас, якобы разработан - это как раз программа, документация и многое другое.

Использовать "советские" ГОСТ, конечно, нет смысла. Они делались для того, чтобы оправдать существование всяких ...ПРОГРАММСИСТЕМ советского образца, для которых нужен был не результат, а процесс самосуществования.

Дмитрий Баранов дает очень разумный совет. Советую также ориентироваться на стиль самого техзадания. Лучше всего состав и оформление документации оговорить с заказчиком. Если ему она нужна для дела, то форма особого значения не имеет. Делать надо, поставив себя на место специалистов заказчика, которым с этим добром придется работать. Если же заказчик такой же подлый, как я, и специально требует "сопроводиловку", чтобы осадить крутого автора, все может быть сложнее...

← →
Fellomena (2002-05-14 12:06) [5]

2 ShaggyDoc © (14.05.02 07:31):
Многоуважаемый ShaggyDoc, всё не так брутально, как Вы думаете!
О том, что составление документации на промышленный прог.
продукт, за который ты, как юридическое лицо получаешь деньги, дело не простое - мне известно.
НО! У меня не всё так запущено, как кажется.
В моей программе заинтересован прежде всего заказчик и строить мне всякие бюрократические припоны - смысла нет.
Но мне самой хотелось бы предоставить относительно законченный программный продукт =)
Я думаю, что оформление на уровне какого-нибудь серьёзного курсового или диплома в вузах вполне сгодится.

Кто когда-нибудь сдавал проги в универе? (на курсовых или дипломах)

Нужен пример или ссылка.

← →
paul_shmakov © (2002-05-14 12:25) [6]

если интересует академический подход, то советую:
В.В. Липаев, "Документирование и управление конфигурацией программных средств. Методы и стандарты.".
http://sinteg.chat.ru/izd7.htm

← →
Fellomena (2002-05-14 12:53) [7]

2 paul_shmakov © (14.05.02 12:25):
угу, есть такая... новая даже относительно - 2001 года.
Проблема в том, что именно академический подход... практического там чуть... 8(

Для полноты впечатлений посмотри RUP (Rational Unified Process)
Там до зеленых чертиков всяческой документации и требований.
http://www.rup.org/

Прошу прощения, ссылка не та.
http://www.rational.com/

Дмитрий Баранов (13.05.02 19:26)
Подойти творчески и взять за образец документацию всеми любимого гиганта софтверной индустрии (SDK, API, Knowledge base :) Но это имхо :) Ну в крайнем случае мануалы соорудите... консольные... a la Free BSD какой-нить ... OpenSourc`овей не придумаешь. Чем не образец?

Ты еще MSDN посоветуй :)))

Поставка прог. продукта заказчику. Что использовать ISO, ГОСТ ? Найти похожие ветки