Поделитесь опытом, кто-нибудь документировал свои доработки именно технической документацией? Не инструкция пользователя (какие кнопки нажимать - такой документ имеется), а нечто другое. Вот есть такая задача к завершению проекта. "Разработка технической документации".

Для этого есть стандарты и все это достаточно легко ищется в инете. Вот навскидку: http://standartgost.ru/g/ГОСТ_Р_ИСО/МЭК_15910-2002

(0)Я тебе сразу скажу. Забей и пиши внятные пространные комментарии.Все остальное- от лукавого и НЕ работает.

+ (1) Хорошо и правильно оформленная документация, кстати, попадается к некоторым российским продуктам. Например мне попадалась к екатеринбургской системе BioSmart (http://www.bio-smart.ru). Можно качнуть у них с FTP-сервера и использовать как пример.

через полгода без коментов тебе никакие манулв лично написанные не помогут:-)

*мануалы

(2) у человека другой вопрос. Ему нужно сделать техническую документацию. Когда так ставят вопрос, как правило, подразумевают документацию в соответствии со стандартами. Простое описание или комментирование не прокатывает.

(6)Тут ключевое слово - СВОИ

(7) ну и что? Свои надо документировать не по стандартам, а строго как попало?

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

(8)Свои  вообще надо забить на стандарты и делать так что бы ты вспомнил и не маялся . Потом. Про что это сука тут писал какой то придурок??..В..это я же был

причем с годами своего становится НАСТОЛЬКО много...Что только каменты и спасают

(10) Так, может, он для кого-то ее разработал. И этот кто-то требует в соответствии с договором правильную документацию.

(12)Чукча даже не читатель?
>>кто-нибудь документировал свои доработки

(3) на ftp://bio-smart.ru не пускает

>>Не инструкция пользователя

(15) нет такого документа по госту. Есть документ "руководство оператора", кажется так. Хотя могу и ошибаться

(16)Отсыпете модераторам...

(14) http://www.bio-smart.ru/support

(18)http://button.dekel.ru/

тебе пригодится:-)

(1) Спасибо, обязательно посмотрю. И все-таки кто-нибудь лично такую "книгу" сочинял?

Прикольные формулировки:

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

Как бы измерить "плодотворность контактов"? И "понимание сути"?

(21) Вы знаете, сочинял. На моей специальности в вузе это требовалось, к курсовым мы писали документацию по ГОСТу, но дело в том что это были 90-е гг. Можно чего-то и поднять, найти, но сейчас требования стандартов изменились.

(22) поскольку лично вы и являетесь разработчиком и документатором в одном лице, к вам эта формулировка не относится. Очевидно, что вы суть понимаете и плодотворно контактируете сам с собой :)

(23) Ну да, формальные фолианты "по стандарту"и мне приходилось ваять. Раза три.
Только потому, что они должны быть предоставлены.
И НИКТО НИКОГДА ими не воспользовался...  

А сейчас интересно, вдруг уже имеется опыт написания осмысленной документации? Не являющейся "Руководством пользователя".

(25) Я вообще не вижу проблемы. Сочинения и изложения в школе писали? Возьмите документацию, которая лично вам кажется хорошей, и напишите такую же по своему продукту.

А если вам надо именно по программному коду и для себя, а не для предоставления куда-либо - тогда я полностью соглашусь с (2).

(26)
>>Возьмите документацию, которая лично вам кажется хорошей,

В том-то все и дело, что не нахожу таковой. Вот и обратилcя на форум "за идеями".

(28) я ссылку тут давал по биосмарту. На мой взгляд, очень хорошая документация там.

(28)>>Вот и обратилcя на форум "за идеями".
Извини, конечно, да че там- не извиняй!
Ты идиот. И идеи у тебя идотские.
(поправляя галстук)
Всего хорошего, господа.

(30) Зато я знаю, куда тебе обратиться - к психиатру. Они, по слухам, хорошо влияют на тех, кто беспричинно на людей бросается. Желаю удачно вылечиться!
Удачи!

(28) Вот, посмотрите, практически ваш случай - расширение к 1С: http://www.bio-smart.ru/uploads/files/files/2015/Instraction/Biosmart-1C.%20Руководство%20пользователя%20v1.03.pdf

(31) А источник этих слухов можно озвучить? А то, панимаэщ ли... Я был женат на психиаторе... О хорошем влиянии и речи не было...

(30) "поправляя галстук"
Галстук из Колумбии?

(34)Нет.Местный.
Из Джейрана.
Есть такой зверь в Казахстане, если ты не в курсе.

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