![](https://habrastorage.org/getpro/habr/upload_files/36f/ad0/0a8/36fad00a8172063155df63fd3bd47520.png)
Привет, Хабр! Меня зовут Богданова Софья, я технический писатель в компании Documentat, где мы занимаемся разработкой технической документации для различных IT-проектов.
За все время работы приходилось сталкиваться с кучей разной документации, но сейчас я плотно засела с документированием по ГОСТу. Собственно, о чем и будет этот пост.
Непросвещенному читателю ГОСТ может показаться канцелярскими дебрями, где для разъяснения одного предложения надо найти остров, на острове дуб, под дубом сундук и далее по списку. Но на самом деле, если разобраться и вникнуть в ГОСТовскую кухню, то с этим можно жить и даже активно пользоваться.
Что такое ГОСТ и зачем он нужен?
В далекие времена, когда изобретения ограничивались палкой-копалкой, потребности в их стандартизации особо не было. Когда производство приобрело большие масштабы, а сами изобретения стали сложнее по количеству составных частей и выполняемых ими функций, появилась необходимость всё это дело как-то привести если не в общий вид, то хотя бы в какой-то более менее стандартный.
Нужно это было прежде всего государству, чтобы ограничить выпуск некачественной продукции. Отсюда мы и получаем ГОСТ — государственный стандарт.
ГОСТов много, описывают они всё что можно и нельзя, но здесь мы будем говорить о стандартах написания технических документов.
“А зачем мне надо документы писать по каким-то стандартам? Я понятным языком напишу, все поймут отвечаю”
К сожалению, что понятно одному, может оказаться теорией струн для другого. Для того, чтобы любой желающий мог открыть документы и найти в них то, что так давно искал, были придуманы стандарты по их написанию.
Очень хорошо это демонстрирует техническое задание.
![](https://habrastorage.org/getpro/habr/upload_files/d25/a38/447/d25a38447df39a3ee83c17f6fe587ca1.png)
При разработке чего угодно важно отразить желаемый результат. Очень удобно разрабатывать, когда есть понимание, что же все-таки от тебя хотят. Свои желания все формируют по-разному и чтобы в потоке мыслей не потерять суть, а донести желаемое, удобно пользоваться готовым стандартом, который вы с разработчиком будете читать, а главное понимать одинаково.
В этом и есть основная суть ГОСТа — стандартизировать техническую документацию таким образом, чтобы она была понятна и разработчику, и конструктору, и даже тёте Ларисе из бухгалтерии.
Как выбрать нужный ГОСТ?
Вообще, такой вопрос обычно возникает крайне редко, так как чаще всего заказчик или организация, в которой вы работаете, говорят вам: «Нужны документы по ГОСТ 19».
Но если вам приходится самому решать, какой ГОСТ лучше использовать, то я дам совет.
При разработке документации на IT-продукты выбор стоит между двумя группами стандартов — 19 и 34. И здесь все очень просто.
ГОСТ 34 — автоматизированные системы (АС).
ГОСТ 19 — программное обеспечение (ПО).
Как понять, что у вас система? В ней, помимо ПО, еще будет аппаратная часть, то есть будет что-то сказано про оборудование, которое входит в состав системы.
Важная ремарка. Всегда обращайте внимание на требования к оформлению документов — нумерация разделов, использование рамок, заполнение основных надписей. От ГОСТа к ГОСТу эти требования различаются.
В общем случае используется оформление по ГОСТ 2.105-19, но стандарты 19 и 34 серии имеют свои заморочки. Возможно, я наберусь сил и сделаю об этом отдельный пост.
Зачем проверять актуальность стандарта?
С актуальностью я столкнулась будучи еще зеленой. Надо мне было разработать пояснительную записку. Окей, гугл — пояснительная записка ГОСТ. Нахожу стандарт, все радостно расписываю, а потом открываю его на другом сайте и вижу это страшно слово: «Недействующий». Думаю, не стоит описывать степень моего негодования в тот момент, а то, боюсь, не обойтись без нецензурных высказываний.
Но, как известно, негативный опыт — это тоже опыт. Поэтому с тех пор я всегда проверяю актуальность, прежде чем брать стандарт за основу.
Легче всего проверить актуальность стандарта можно на сайте https://docs.cntd.ru/.
Ищете там свой стандарт и, затаив дыхание, открываете его. Вверху страницы будет строчка, которая либо вас очень обрадует, либо сильно разочарует.
![](https://habrastorage.org/getpro/habr/upload_files/fa2/724/493/fa27244935b254df0ecc311c01afa092.png)
Может быть и третий вариант:
![](https://habrastorage.org/getpro/habr/upload_files/72a/4df/8cf/72a4df8cff230ee866bcc80d8e9d3299.png)
Обычно это значит, что есть новый стандарт, нужно только его поискать. При поиске вводим обозначение стандарта без года принятия.
Например, если мы нашли ГОСТ 2.105-95, и он оказался недействующим, то в поисковой строке напишем «ГОСТ 2.105» и, хлопая в ладоши, найдем этот ГОСТ уже 19 года.
Частный случай
А что делать, если в ТЗ прописан список необходимых к изделию документов, да еще и прописано, по каким ГОСТам их надо делать, а эти ГОСТы успели устареть?
Конечно, это очень неожиданно и неприятно, но самый главный совет — не принимайте самостоятельных решений и идите к заказчику. Он подскажет. А если нет — делайте по ТЗ. Так больше вероятности защититься.
В общем и целом, если вы только начинаете свою работу с ГОСТом, я советую вам придерживаться следующего плана при разработке документации:
-
Выберите нужный ГОСТ (если нет указаний от заказчика)
Отдельно может понадобиться ГОСТ по оформлению (обычно в стандарте прописано как оформлять или дана ссылка на соответствующий ГОСТ)
Найдите и обязательно проверьте актуальность
Внимательно прочитайте весь стандарт
Сделайте заметки о наиболее важных пунктах (очень полезно, если эти заметки еще и сохранять — вместо того, чтобы заново читать стандарт, всегда сможете быстро освежить его в памяти)
При разработке документа держите стандарт/заметки перед глазами
Когда документ готов, перечитайте стандарт (по первости что-то можете упустить)
Надеюсь, что эта инфа будет полезна тем, кто только начинает свою работу с ГОСТом.
![](https://habrastorage.org/getpro/habr/upload_files/44e/56a/2e7/44e56a2e7e13b9011e28d0d48d4f22a1.png)
Комментарии (4)
hw_store
14.02.2022 13:18Сейчас сам занимаюсь этой проблематикой, только не в области ПО, а в разработке железок. Этикетка, РЭ, ведомость эксплуатационных документов, вот это всё. Довольно заковыристо. Насчёт "сундука на острове" очень верно подмечено ))
runaway
14.02.2022 18:34Легче всего проверить актуальность стандарта можно на сайте https://docs.cntd.ru/.
Легче, но пользы немного. Вбивайте в гугл и скрольте вниз в выдаче до ссылки на normacs.ru. Там внизу страницы будет ссылка на заменённый номер ГОСТа.
Один момент: эта ссылка тоже может быть отменённой ("нормацс" выдаёт линейную последовательность замен). Поэтому прыгаете на следующую версию и "пробиваете" её аналогично.
Я так как-то очень сильно опозорился, и выдал всем в качестве руководства неактуальный стандарт.
Urub
15.02.2022 22:24Казалось бы ГОСТ должен помогать, а на деле пишу документы по программе только ради галочки, ибо описывать работу программы текстом это не эффективно и только трата времени. Нет интерактивности, нет синхронизации с изменениями кода, разве что хелловорды описывать.
ryo_oh_ki
Не "или", а "и", и не только. Собственно 34 группа (автоматизированные системы управления в частности) основывается, дополняет и частично заменяет 24 группу (автоматизированные системы в общем). Так что, обычно, разработка большого ПО ведётся по трём группам, а так же по ЕСКД (основные документы, типа спецификации). Далее необходимо пройти сертификации ПО (например, на метрологию или работу с ПД) и в наших реалиях желательна регистрация в Росреестре - на это существуют разные специфические ГОСТ Р, РД, и отраслевые/корпоративные стандарты.
И ГОСТ не служит для "ограничения выпуска некачественной продукции" (скорее следит за формальной полнотой документации), для этого есть специальные наборы ГОСТ МЭК/ИСО по управлению качеством ПО, циклом разработки и сопровождения.