ОСОБЕННОСТИ ДОКУМЕНТИРОВАНИЯ ДЛЯ РАЗРАБОТЧИКОВ

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

Читать далее

DocPlace 2018-11-06

Как присвоить номер документа по ГОСТу

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

Читать далее

DocPlace 2018-09-04

Создание документации для информационных систем по ГОСТ 34 и ГОСТ 19

В современном мире каждый день появляется десятки и сотни различных программ, приложений, информационных систем. Они могут быть разработаны как для государственного или коммерческого сектора, так и для обычных пользователей. 90% всех пользователей не читает документацию, считает её скучной, занудной и неинтересной, а открывает руководство пользователя только тогда, когда что-то не получается или разобраться без инструкции уж совсем невозможно. Общепринято теперь строить пользовательский интерфейс таким образом, чтобы он был интуитивно понятен, и пользователь мог разобраться с системой, не прибегая к чтению длиннейших мануалов. Однако, при работе с крупными заказчиками практически всегда необходимо сдать определённый пакет документов – руководств, инструкций, проектных решений, оформленных по ГОСТу.

Читать далее

DocPlace 2017-12-11