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

Унылый троллинг растянулся на 6 страниц, лор не торт.

не обучают разрабатывать документацию

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

потому что это не надо целевой аудитории, видимо. бодишопы на каждом углу не располагают к гостам

Наверное, потому, что в серьёзных конторах есть специальный отдел документации. Программист им на пальцах или как-то кратко поясняет, что к чему, а они уже разбираются сами со всяким бюрократическим маразмом. Программисту платят большие деньги. Если он за эти деньги будет создавать макулатуру вместо кода - предприятие просто разорится. А на одну зарплату программиста можно нанять пять девочек, которые нихрена не знают, но умеют вот эти бумажки оформлять, всякие там картинки для юзеров делать и прочее. Так что выгоднее содержать отдел документации. Максимум, что может требоваться от программиста - техническая документация на код. Но это обычный doxygen и его всем программистам вполне хватает.

«Руководство сис. программиста» тебе девочки напишут? И ничего не перепутают и не переврут? Они только оформить это могут, и то за ними 5 раз проверить и исправить надо.

комплект документации

это не программист, а технический писатель же

А что это за руководство то такое ?
Типа как водить руками по бубну если при записи в регистр, АЛУ продолжает использовать его теневое значение ?

Давненько на ЛОРе не появлялось таких годных троллей.

Унылый троллинг растянулся на 6 страниц, лор не торт.

ЛОР такой ЛОР.

«Руководство сис. программиста» тебе девочки напишут?

За одно это выражение «Руководство сис. программиста» я бы уже руки оторвала тому неграмотному идиоту, кто его придумал. Потому что системный программист читает только доки на ось и мануалы на чипы и всё, пожалуй. И другие руководства ему какбэ не нужны по определению. А что касается юзерской документации - да, отдел техдокументации. Программисту хватит doxygen'а, если он не умственно отсталый. Более того, нормальный программист доки по ГОСТу ни писать, ни читать вообще не будет. Потому что уровень маразма там зашкаливает. Нормальная дока составляется и отправляется девочкам, на гостовский обфускатор. После этого дока превращается в нечитабельный маразм, наполненный аббревиатурами типа НГМЖД и прочей ересью, распечатывается на полтонне бумаги и навечно хоронится в каком-нибудь архиве. В реальной работе это никогда не потребуется и программист это знает.

И другие руководства ему какбэ не нужны по определению

а IEEE стандарты документации процесса разработки для девочек написали ?

http://de.wikipedia.org/wiki/SVVP

конечно понятно - чтобы налабать и ни за что не отвечать можно даже доки на процессор не читать :)

а IEEE стандарты документации процесса разработки для девочек написали ?

именно! вы быстро учитесь и делаете определённые успехи. поздравляю.

Я много работала, в том числе с этими IEEE, сертификациями по ISO и т.д. Знаете, что это такое на самом деле? Просто способ срубить бабки. И всё. Нет ничего более халявного, чем заколачивание бабок на никому не нужных, но якобы обязательных стандартах, платных документациях, сертификациях, комиссиях, менеджерах по хрен-знает-чему и прочей бюрократии. И, конечно, всё это точно так же продаётся и покупается, в том числе не только у нас, но и в просвещённых европах (я это не с потолка беру, я просто знаю как всё это делается). Заплатил бабло - получил бумажку. Так что все эти напыщенные возгласы о стандартах имеют смысл лишь пока эти стандарты бесплатны и открыты для всех и разрабатываются сообществом реально работающих компаний или разработчиков. Остальное - чушь, высосанная из пальца ушлыми бюрократами.

Заплатил бабло - получил бумажку.

а потом пришел с продуктом к покупателю и получил «до свидания», баблом конечно можно все дискредитировать - даже самые здравые идеи.

[qiote]а потом пришел с продуктом к покупателю и получил «до свидания» На самом деле, зависит от покупателя.

Если это какая-нибудь госструктура, то они смотрят только в бумажки, остальное им неважно, им надо освоить бюджет и закрыть годовой отчёт. Классика жанра - бюджетная закупка фиг знает чего перед новым годом.

А если это бизнесмен, который считает свои деньги, то ему пофиг на твои бумажки, ему нужен работающий агрегат и трясти бумажками перед ним бесполезно. Более того, наличие бумажек напрямую влияет на удорожание конечного продукта, поэтому на рынке можно запросто проиграть, если конкурент может сделать то же самое, но дешевле.

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

наличие бумажек напрямую влияет на удорожание конечного продукта

да вы бизнесвумен я смотрю таритесь китайским ширпотребом постоянно ? а что - никто не сдох, а то что завтра сломается так новое купите. Только такой подход далеко не всегда работает - иногда такие бизнесьмены законно получают в табло.

Если это какая-нибудь госструктура, то они смотрят только в бумажки

зависит от ситуации - то что бумажки не 100% гарантия давно всем ясно.

даже самые здравые идеи

Кстати, насчёт «здравых идей»... Вспомнилось тут. Вы в курсе, что по ГОСТам поставщик должен предоставить распечатку исходного кода? Помню, как-то одна очень крупная федеральная структура затребовала (по ГОСТам, конечно) полную распечатку всего кода для очень крупного проекта. Начальство спустило приказ - мол, давайте, распечатывайте! Я не стала торопиться. Взяла калькулятор, прикинула объём кода, плотность бумаги, и отправила им запрос: уверены ли они, что хотят получить около 4 тонн распечаток? Они там долго мялись, но потом всё-таки согласились наплевать на ГОСТ и получить просто CD с исходниками. И я более чем уверена, что этот CD они ни разу не использовали.

Кстати, насчёт «здравых идей»... Вспомнилось тут. Вы в курсе, что по ГОСТам поставщик должен предоставить распечатку исходного кода?

вы в курсе что ГОСТ-ы пересматривают и корректируют и существуют редакции разных лет ? В РФ с национальными стандартами полная засада была по крайней мере - сколько этот технический регламент мусолили.

да вы бизнесвумен я смотрю таритесь китайским ширпотребом постоянно ?

Что вы, я от бизнеса далека. Я программист. Но у меня большой опыт работы и я просто наблюдаю, как всё это происходит в разных компаниях. И делаю выводы. А насчёт Китая: он нас давно обогнал по качеству, так-то. Ещё немного - и даже Индия и Мексика нас обгонят.

Сертификаты ничего не гарантируют, к вашему сведению. Гарантия и техподдержка - это совсем другая область, вообще не связанная с сертификацией, и не надо мешать всё в кучу. Сертификация НЕ даёт гарантии. Сломаться оборудование может хоть на следующий день, это не значит, что товар не сертифицирован. Примеров навалом.

А в табло получают только в нашей дебильной и дикой стране. В нормальных странах люди разбираются меж собой мирно или идут в суд :)

Сертификация НЕ даёт гарантии.

вы вообще в курсе - что такое сертификация ? Сертификация удостоверяет соответствие нормативным документам - ГОСТ, ТУ, РД и пр., гарантию дает производитель. Важность национальных стандартов элементарно понять хотя бы из климатических различий - в СССР на БАМе были случаи когда импортная техника именитых производителей разваливалась за неделю - климатическое исполнение другое, металл на морозе разрушается моментально. Так-то.

Хватит трахать людям мозг про тонну бумажек.
http://www.docload.ru/Basesdoc/6/6585/index.htm
Все прекрасно передается в электронке, если заказчик упорыш, то тыкаешь его носом в его любимые госты, он довольно хрюкает от того что разбираешся и принимает.
Большинство маразма в ЕСПД носят рекомендательный характер.
21вый век на дворе, программисты не в состоянии написать себе рыбу, под ненавистный стандарт и работать, приехали млин

Согласно Закону РФ «О стандартизации» ответственность за нарушение его положений несут юридические и физические лица, органы государственного управления. В соответствии с действующим в России законодательством ответственность носит уголовный, административный либо гражданско-правовой характер. Нарушения выявляются службами государственного контроля и надзора за соблюдением субъектами хозяйственной деятельности обязательных требований государственных стандартов.

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

Прокурору ты это все расскажи, ага.

ГОСТ это текст, сравнительно простой, --- а читать вроде в школе учат.

обязательных требований государственных стандартов.

Что из названной в этом треде хрени является обязательным требованием?

Это стандарт 78-80-х годов. Тогда распечатывание кода на бумажках имело ценность как бэкап.

Теперь это стало никому не нужной дублирующей макулатурой. И это при наличии doxygen и систем контроля версий. Просто позор.

Действительно хороший тролль, учитесь.

Стандарт не читай, сразу отвечай, правда?
Черным по белому написано, «для любого способа выполнения документов на различных носителях данных.», электронные в том числе. Подразумевает под собой, что сдача документов на бумаге вовсе не обязательна. Надо сказать в бумажном виде, вид исходников не регламентируется, код распечатанный рулоном, вполне принимался приложением к документации. Стандарт действует по сей день, и только лень не дает вам сил прочитать десяток другой страниц.

Один хрен - сдавать его распечаткой или монструозным доковским файлом.

Кто сказал доковским? Да хоть TeX'ом, строгого формата нет.

Да не суть.

По-моему у тебя каша в голове. ГОСТы были в совке, используются еще в РФ. В Украине используются ДСТУ, при отсутствии стандартизации по ДСТУ разрешается использовать совковые ГОСТы, российские ГОСТы не имеют официального статуса. Есть еще ГОСТы ратифицированые странами участницами СНГ, причем список ратифицировавших участников плавает от стандарта к стандарту. В западном мире в основном используется ISO, в штатах активно используется ANSI, у китайцев есть своя система стандартизации. Ты же привел совковый ГОСТ и зачем-то привел его английское название, хотя большинству англоязычных «стандартоведов» положить на систему ГОСТ.

По сабжу согласен, в ВУЗах имхо недостаточно натаскивают на качество документации. Был удивлен растяпством выпускников строительных ВУЗов в этих делах. Как-то сам решил выгрести авгиевы конюшни с документацией по нашим продуктам. Чтоб все в соответсвии с ЕСКД, чтоб идеально было. Начал возиться и понял что на эту работу мне надо положить ~2 мес. своего времени. При том что у меня есть более приоритетные задачи - работающий код. Хотел запилить АС для создания документации и собственно сделать документацию, но так руки и не дошли.

Если у вас крупная контора - скорее всего вам лучше искать технического писателя. Программист должен выполнять ТЗ и создавать продукты требуемые заказчиком, а не задротить стандарты их описания. Пусть как говорится в «Большом» поют, а я буду оперировать. Короче суть сабжа в сраче широпрофильность vs узкозаточенность. Спор похоже вечный, а я сторонник узкой заточки. И да, напоследок: технический писатель запросто может иметь образование программиста, самостоятельно читать код и даже давать советы основным дэвам - в мире не все стандартизируется ;)

И да, напоследок: технический писатель запросто может иметь образование программиста, самостоятельно читать код и даже давать советы основным дэвам

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

Прокурору ты это все расскажи, ага.

О-о-о, понеслась. Манагер, небось? Программист такой пафосной глупости в жизни не скажет.

Я могу сказать только то, что программист в любой момент запросто сменит место работы. А вот начальство со своими стервозными тётками-мозгоклюйками останется. Поэтому для самого начальства выгоднее держать их в узде и следить, чтобы они не мешали разработке. Грамотное начальство так и делает: разделяет интеллектуальную работу и возню с макулатурой. Каждый занят своим делом: программист - программирует, дворник подметает двор. А ту гниль, которую вы тут втираете, можете оставить для госпредприятий, где за еду и крышу над головой студенты кропают говнокод. Программисты из таких мест уходят, набрав немного опыта. И правильно делают.

Сдают напечатанные листинги на паскале и рисуют линии по ГОСТу вместо программирования.

Истинно так.

ты кого толстой назвал ? :)

А еще сраные погромеришки зачастую не знают английского языка! Гнать их в шею! Пусть дворы метут, неучи!

Сказал человек, которые пользуется КОИ8.

И каким тут раком КОИ8? Отличная кодировка. Да, буквы не по алфавиту, но я уже привык.

Ни у одной курсовой нет задачи документирования, как максимум задача описания проекта и код как решение.

задача описания проекта

учат. например, на ИТМО есть А. Шалыто с «Движением за открытую программную документацию». must read

на мой взгляд ... программист должен уметь разработать полный комплект документации в соответствии с ГОСТ и требованиям ПЗ.

упрлс? начнем с того, что просто хоть какую-то *хорошую* документацию, не по ГОСТ 34.* и т.п. — и то ниасиливают.

сами по себе стандарты ГОСТ, ЕСПД, и т.п. — перегружены слишком, но являются необходимым требованием для составления «ТЗ на автоматизируемую систему», поэтому и используются. часть этих требований устарела, и в итоге вместо кирпича по ГОСТам нужно было бы написать что-то менее многобуквенное, более краткое, человекопонятное, но вместе с тем и достаточно ёмкое, конкретное — более гибкое.

вот о таком более гибком процессе нужно думать — писать для чукчей-читателей было бы более полезно, чем кирпич, который всё равно никто не читает целиком, потому что это написано нечитабельно.

на тему, что документацию не пишут потому что «на это уходит слишком много времени, кодировать некогда, да и всё равно она устаревает, расходится с кодом» — это чушь полная, просто писать в человекопонятном виде в большинстве своём не умеют.

а технические сложности сильно преувеличены: то, что можно — то и нужно по максимуму автоматизировать.

использовать всякие тулчейны типа latex,multimarkdown,python sphinx и т.п.

есть, например, движение reproducible research/literate programming, которое тоже в некотором роде критикуют (особенно LP) за то, что так писать дольше — но не писать читаемое или писать нечитаемое в итоге всё равно выходит дольше.

мозги надо по-другому поворачивать. как-то так: например движение Шалыто за открытую программную документацию и reproducible research подход.

Описание и документация - это две большие разницы.

Разве что у буквоедов типа ТС.

З.Ы. Мы прикладной программный интерфейс, помнится, тоже документировали в работах в универе

Если будет документация, то не нужна будет платная поддержка. А это невыгодно.

Если не будет документации, ты продукт не продашь.

это смотря что именно в проекте ты описываешь. например, если просто доклад «мы строили, строили, и наконец построили», то такое описание нинужно. ну разве повыпендриваться.

а если нужно работающее описание, то оно должно описывать важные, существенные части проекта (то, что А.А. Шалыто называет «проектной документацией»). это по идее,описание архитектуры, процессов, которые в проекте происходят. с достаточной степень детальности, для ответа с достаточной точностью на те вопросы, которые пользователи этого документа (чукчи-читатели) могут задать.

если написан бумажный выкидыш, который никто не читает — значит, непонятно для кого это написано, и непонятно на какие вопросы отвечает.

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

сравни например, как писать научные статьи c примерами как надо и как не надо делать (и рефакторингом второго в первое).

многобуквие уму не научает.

«Если не будет документации, ты продукт не продашь.»

Расскажи это Касперскому. У него в коробке только лицензия и гарантия. PS Покупают софт, а не документацию.

программистов учить русском? Вы ничего не перепутали? мб англицкому?

По крайней мере, человек, пишущий документацию на русском языке, обязан им владеть. Хотя бы настолько, чтобы разбираться в «тся» и «ться» и не ставить (здесь тонны ненависти) запятую между подлежащим и сказуемым.

Любой инженер, помимо разработки узла для машинного доения, обязан сдать полный комплект конструкторской, программной и эксплуатационной документации заказчику. В чем отличие от программиста?

Всё же инженер инженеру рознь.

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

У инжерере-программиста всё же главный результат - это программа, она самоценна сама по себе. А «текст программы», оформленный как документ 12 по ЕСПД - это всего лишь бездушный слепок. Что же касается эксплуатационной ПД, то она предназначена для пользователей, для которых компьютер - всего лишь инструмент. Написание такой документации требует совершенно отдельных навыков.

Поэтому ПД пусть всё же пишет технический писатель. Мой опыт подсказывает, что через некоторое время после того, как программиста заваливают написанием ПД, программист умирает или убегает.

что подразумевается под полным комплектом? это когда ты в документации указываешь отладочную информацию, алгоритмы, и пр. вещи, которые могут заинтересовать другого программиста?

Внезапно, такой документ тоже есть, называется «Описание программы» и имеет в ЕСПД характерный номер 13. Делается, как правило, для всяких сертификаций.

Внезапно, такой документ тоже есть, называется «Описание программы» и имеет в ЕСПД характерный номер 13. Делается, как правило, для всяких сертификаций.

Да я и не отрицал, что он есть. Вопрос там был в другом

Программист ещё и тестировать иногда должен, но это не значит, что все программисты должны быть тестировщиками.

Вот это, кстати, чрезвычайно здравая мысль.

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