При фразе «Документирование API» многие приходят в ужас, так как, на первый взгляд, это кажется очень трудным, страшным и тяжёлым. Документ по ГОСТу сразу кажется небольшой детской сказкой на этом фоне. Но не так страшен чёрт, как его малюют! Я не говорю, что документирование API — это легко и просто. Да этому нельзя научиться из одной короткой статьи или видео, но если придёт понимание этой темы, то и на изучение этой темы уйдёт гораздо меньше времени. Да–к, что же такое API? И как его задокументировать?
Метка: документация
Видеоинструкиция — когда один раз лучше увидеть!
Большинство людей не читают инструкции к новым программам, будем честными, читает бумажные или электронные документы 3% из 100%, не больше. Все они надеются, что смогут освоить их самостоятельно при помощи метода «научного тыка». Но увы, это возможно не всегда. В эпоху ХХI века найден простой способ обучить пользователя новой программе без больших томов документации и личного присутствия — это видеоинструкции. Видео, как правильно воспринимаются пользователем значительно лучше, чем печатный документ.
Как написать Техническое задание по ГОСТу
Техническое задание (ТЗ) — перечень требований, условий, целей, задач, поставленных заказчиком в письменном виде, документально оформленных и выданных исполнителю работ проектно-исследовательского характера. Такое задание обычно предшествует разработке проектов и призвано ориентировать разработчика на создание проекта, удовлетворяющего желаниям заказчика и соответствующего условиям использования, применения разрабатываемого проекта, а также ресурсным ограничениям.
Зачем нужно Техническое задание?
Многие
ОСОБЕННОСТИ ДОКУМЕНТИРОВАНИЯ ДЛЯ РАЗРАБОТЧИКОВ
Процесс документирования для пользователей давно отлаженная система, но основной болью и по сей день остаётся процесс написания документации для разработчиков (программистов). Написание документа для программистов вводит в ступор и страх любого писателя, так как, на первый взгляд, это кажется, что-то запредельное и непонятное. И тут я собственно буду согласна, так как не каждый специалист сможет написать документ для отдела разработки, этим должен заниматься писатель, который имеет достаточные базовые
Как присвоить номер документа по ГОСТу
Согласно стандартам ЕСКД, ЕСПД и КСАС каждой программе, системе, документу должно быть присвоено обозначение, которое состоит из группы цифр и букв, разделённых точками, пробелами, дефисами. Обозначение присваивается по правилам для унификации и упрощения идентификации изделий и документации на них, ведения учёта и архива.
Присвоить номер, код или шифр документу, со сторону кажется целой наукой, тайным знанием. Однако, это проще чем кажется! Можно ли не присваивать этот мистический номер созданному
Создание документации для информационных систем по ГОСТ 34 и ГОСТ 19
В современном мире каждый день появляется десятки и сотни различных программ, приложений, информационных систем. Они могут быть разработаны как для государственного или коммерческого сектора, так и для обычных пользователей. 90% всех пользователей не читает документацию, считает её скучной, занудной и неинтересной, а открывает руководство пользователя только тогда, когда что-то не получается или разобраться без инструкции уж совсем невозможно. Общепринято теперь строить пользовательский интерфейс