11:15

Я не сплю, я перешел в режим замедленного функционирования
Вот она, суть техдокументации: инструкцию "Запустить, ввести логин, ввести пароль, нажать на кнопку" мне пришлось растянуть на 10 страниц...

Комментарии
30.08.2013 в 13:27

I ain't got much to say
Nope. Эта инструкция должна быть одной страницей. А еще должны содержаться инструкции по установке, удалению, обновлению, ссылки на нормативную документацию, требования к железу и оси. Это так на вскидку. Если уж называть технической документацией. А. Еще собственно требование изготовить (тт) и твое описание как оно будет изготовлено и будет работать (тз)

ПОЧУВСТВУЙ СИЛУ БЮРОКРАТИИ!!!111 :)
30.08.2013 в 14:08

Я не сплю, я перешел в режим замедленного функционирования
Эта документация скатилась до таких инструкций, как "если дата меньше 2012, то на компьютере неправильно установлена системная дата", "если возникает ошибка "сеть недоступна" - посмотрите, подключен ли белый провод с прямоугольным разъемом и защелкой к задней панели компьютера", и так далее. Хорошо хоть глава "Список ошибок и способы их устранения", занимающая больше половины документа, предназначена для более менее смыслящего существа, так что там мне хоть не пришлось описывать, что значит "поле ввода" и "исполняемый файл".

по установке, удалению, обновлению
Это не нужно, так как программа уже полностью установлена и работоспособна, а за удаление деятелю будет назначена тележка раздаточных материалов.

требования к железу и оси
Есть

Еще собственно требование изготовить (тт) и твое описание как оно будет изготовлено и будет работать (тз)
ТЗ - это уже не мое, поскольку я являюсь исполнителем этого самого тз. А что есть тт?

Но да, это не столько техдокументация, сколько банально инструкция использования :)
30.08.2013 в 14:20

Покайся, раб!
Дрег Ден, для "шибкоумных" людей за 40 и деффочек, у которых его нет с рождения? Просто для иных людей маны можно сократить...
30.08.2013 в 14:27

Я не сплю, я перешел в режим замедленного функционирования
ManuUmAn, на первую редакцию моей инструкции, сформулированную для существ с IQ больше 80, начальство сказало, что требуется больше уточнений, а то могут не понять. Так что я пошел в overdrive :D.
И вся эта документация была нужна для моего коллеги, который заменял бы меня одну неделю.
30.08.2013 в 14:28

I ain't got much to say
ТТ - технические требования. На основе их делают ТЗ. И то и другое должно входить в полный комплект технической документации. Кстати и на то и на другое отдельно для софта есть Госты :)

эээ ... Документация для коллеги? Передается в устной форме фразами вроде "это не нажимать, а это нажимать" :)
30.08.2013 в 14:37

Покайся, раб!
Дрег Ден, печальная история о мозге, который ушёл в отпуск и не вернулся...
grayscalechaos, для софта есть Госты - зная то, что принимают их те, кто вообще не сечёт - читать с намерением поржать, не более....
30.08.2013 в 14:45

I ain't got much to say
ManuUmAn, а так же если ты намерен продавать и как либо сертифицировать свой софт. Естественно речь о софте промышленных масштабов.
30.08.2013 в 15:11

Покайся, раб!
вот поэтому лицензионное соглашение и не читают...