Учимся писать документацию

← →
Ozone © (2004-11-04 13:35) [0]

Вобщем суть проблемы в следующем - изучаем на курсе предмет "Технология и разработка ПО". Есть задача разработки некоего (у каждого свое) программного средства. А это ни что иное как сама программа + документация.
Вроде программы с горем пополам немного научились делать... а вот с документацией проблемы.

Может кто-нить натыкался в нете на статьи по данной теме?
Нужно именно:
- как описывать спецификацию (функциональную и качества);
- как составлять и анализировать тесты;
- как доказывать правильность свойств программ.

Заранее большое спасибо за любую ссылку по теме.

← →
Игорь Шевченко © (2004-11-04 13:37) [1]

> изучаем на курсе

А что говорит преподаватель курса ?

← →
Ozone © (2004-11-04 13:43) [2]

Игорь Шевченко © (04.11.04 13:37) [1]

У нас получился курс урезанный (постоянно в разъездах). Он сказал изучать самостоятельно по книжкам. В ГПНТБ (где все это есть) нет времени сходить... работа... Вот и думаю мож чего в нете есть?
Поиск не дал результатов...

← →
blackman © (2004-11-04 13:50) [3]

Есть (были) ГОСТЫ Единой системы программной документации (ЕСПД). :
http://articles.org.ru/cn_old/jump.php?844

← →
Ozone © (2004-11-04 13:56) [4]

blackman © (04.11.04 13:50) [3]

ГОСТ"ы - это отлично. Мне бы еще научиться правильно все это описывать. Идеальным вариантом был бы пример "правильной" документации к некоторому простенькому ПС.

← →
blackman © (2004-11-04 14:54) [5]

>"правильной" документации к некоторому простенькому ПС.
А что считать правильным ? Скачай любую прогу и почитай Readme Вот только не знаю, правильно ли ? :)

← →
Ozone © (2004-11-04 14:58) [6]

blackman © (04.11.04 14:54) [5]

//Скачай любую прогу и почитай Readme

Это все не то, ивините...

// А что считать правильным ?

Это значит по ГОСТ"у я так понимаю.

← →
blackman © (2004-11-04 15:09) [7]

Нет сейчас каких-то особых правил :)
А книга такая была:
Технология разработки программного обеспечения
http://www.delphimaster.ru/books/978594723663/

← →
Jeer © (2004-11-04 15:47) [8]

blackman © (04.11.04 15:09) [7]

Правила есть всегда:))

blackman © (04.11.04 15:09) [7]

Согласен с [8].
За книгу спасибо - обязательно приобрету когда деньги будут.

Но пока нет денег и времени на библиотеку, мож чего путного в сети есть?

> [9] Ozone © (05.11.04 05:04)

Сходи в ГПНТБ. Найди уж время - хотя бы раз. Посоветуйся - может и в сети для тебя сделают поиск. Заплатишь немного - ничего с тобой не случится.

> Идеальным вариантом был бы пример "правильной" документации
> к некоторому простенькому ПС.

Ну, так и возьми за "рыбу" документацию по Дельфи, да и измени-упрости ее под свою задачу...

dmitry99 © (05.11.04 06:34) [11]

:) Спасибо за наводку, но я не настолько хорошо знаю забугоный язык

Думкин © (05.11.04 06:01) [10]

Если б было время, обязательно сходил бы.
Сегодня мне коллега принес несколько книг по теме... на выходных будет чем заняться ;)

Учимся писать документацию Найти похожие ветки