«… Вы впервые столкнулись с необходимостью сделать техническую документацию на изделие, весь пакет или отдельные документы: спецификация, формуляр или различные руководства. Вы смело берётесь за эту работу, она не представляется Вам страшной или сильно сложной (расхожее заблуждение).
Вы с энтузиазмом берётесь за работу, читаете ГОСТы и/или различные рекомендации. И тут Вы к своему удивлению обнаруживаете, что там нет того, что Вам нужно - нужно для Вашего конкретного случая. Всего-то надо сделать: вписать одну строчку, вот только не понятно куда в спецификацию, в формуляр, в руководство или во все сразу, а ГОСТы про это молчат.
Вы не отчаиваетесь. На форумах посвящённых полностью (или не очень) вопросам создания документации и её оформления Вы начинаете оставлять посты со своим вопросом. На этих форумах находятся очень грамотные люди, и они с готовность пытаются Вам помочь.
Вы радостно читаете ответы, вот оно решение вашей проблемы! Но не тут-то было, по мере чтения, у Вас появляется ощущение, что Вы чего-то недопонимаете. Вас опять отсылают читать ГОСТы (в которых Вы ничего не нашли, поэтому и спрашивали) или указывают, как сделать то, что Вам нужно, но опять ссылаясь на пункты ГОСТов.
У Вас появляется маленькое раздражение, это Вы уже видели и не нашли там ничего для себя. Вы уже просто просите: «Покажите пример документации, а я уж сам разберусь и сделаю по аналогии». Тут Вы узнаёте самое интересное: что документация – это очень дорогой продукт, и никто для Вас её не выложит в Интернет. Вы твёрдо решает – без вас обойдусь, и бросаетесь в недра Интернета. И что? Нет в Интернете образов документации, которая Вам нужна. Там какие-то обрывки, учебные шаблоны или формуляры, паспорта на какие-то «маленькие» устройства в основном бытового применения.
Вот, Вы вернулись к началу: как это сделать? Но теперь отсутствует энтузиазм и уверенность в себе…»
Всё, что выше изложено – это только моё личное разгулявшееся воображение. Может быть, это происходит не так?
Но на форумах вопросы о формулярах, паспортах, техническом задании и т.п. и т.д. с упорной регулярностью появляются. Эти вопросы похожи между собой не содержанием, а как именно они сформулированы и такие вопросы могут достигать до 30% от общего числа. Отличительная черта их – на них очень трудно ответить, если это вообще возможно. Ответ на такой вопрос надо начинать чуть ли не с сотворения мира! Вроде вопрос прост, но создаётся впечатление, что человек, задавший его, вообще не разбирается в том, о чём спрашивает, и по этому, соответственно, любой ответ не поймёт тоже. Стоп!!
И ещё раз, стоп!! А если вспомнить себя, товарищи специалисты, вспомнить то время когда ты ещё не был специалистом.
Я помню – это время. То, что для остальных было очевидно, для тебя было тьмой кромешной. Я задавал вопросы, над которыми старшие коллеги смеялись. Им мои вопросы казались глупыми и детскими. Может, оно так и было, но это для них, для меня они были важными и жизненно не обходимыми. Они смеялись, но помогали, я ведь был «молодым специалистом». Но желание задавать вопросы быстро прошло, пришлось больше слушать и смотреть, благо было у кого. И если другой «молодой» спрашивал, внимательно слушал потому, что сам бы спросил, но не хотелось чтобы обсмеяли. Время начала становления специалиста оказывается не такое уж радостное. По мере роста все стараются забыть плохое и неприятное, тем более уже получены ответы на вопросы. Наступает время, когда тебя уже называют специалистом, и многое становится на столько само собой разумеющимся, что когда слышите вопрос (который сами когда-то задавали), возмущаетесь: «Как так, вы этого не знаете? Как вы можете вообще работать, если не знаете этого?».
А ведь, если объяснить человеку принципы построения, то он если и будет спрашивать, то более конкретно и правильно, точно зная, что ему нужно.
Вот из одного такого вопроса и появилась идея этого сайта. Просто и доступно рассказать об основополагающих принципах построения документации, об особенностях практического применения их.
Если человек усвоит это, то всё остальное приложиться. Не придётся более задавать глупых и непонятных вопросов.
Я не претендую на истину в последней инстанции, это только моё личное мнение и мой личный опыт, у другого человека всё своё. Информация на сайте только даёт базу, точку с которой можно оттолкнуться и начать свой, более лёгкий и комфортный путь по стране «Техническая документация».
Пользуйтесь информацией с сайта, копируйте, – я не против, но будьте вежливыми: пожалуйста, указывайте ссылку на этот сайт.
Желаю успеха!
