Нужен ли синопсис технической документации? Личный опыт разработки
Разработка документации на создаваемые ИТ-продукты – это не только «правила хорошего тона», но и насущная необходимость. Ведь без технического задания невозможно зафиксировать требования к продукту, без руководства пользователя сложно грамотно продуктом пользоваться, без технической документации, описывающей продукт...
Разработка документации на создаваемые ИТ-продукты – это не только «правила хорошего тона», но и насущная необходимость. Ведь без технического задания невозможно зафиксировать требования к продукту, без руководства пользователя сложно грамотно продуктом пользоваться, без технической документации, описывающей продукт, сложно будет искать и исправлять ошибки и проводить необходимые доработки, когда в них возникнет необходимость, и т.д.Обычно документацию делают по одному из двух путей – либо используют стандарты, описывающие требования к составу, структуре и содержанию документов (например, ГОСТ 19-й и 34-й серий – ЕСПД и КСАС), либо самостоятельно разрабатывают документ, создавая его на основе собственного опыта или по существующим образцам, в т.ч. взятых из интернета. Но как же её правильно сделать?Мой ответ - начинать надо с синопсиса документов.
Краткая сводка
В статье рассматривается необходимость разработки технической документации для ИТ‑продуктов и сравниваются два подхода к её созданию: использование стандартов (ГОСТ 19, 34) и самостоятельное формирование документов. Автор советует начинать процесс с составления синопсиса, который помогает определить структуру и содержание последующей документации.
Связанные теги
Компании и люди
Линия сюжета
Продолжить следить за темой
Переходите к связанным материалам, страницам сущностей и активным линиям сюжета.
DDD ASP.NET Почему не удобно для больших проектов с более чем 30 реестрами
Domain-Driven Design (DDD) звучит как серебряная пуля. Когда мы начинаем проект на ASP.NET, идея четкого разделения на слои, изоляция бизнес-логики в домене и использо...
Как я прошел ад публикации в App Store и Google Play и получил первые деньги
Я просто хотел выложить мобильное приложение и начать зарабатывать. В итоге – блокировка Google-аккаунта, несколько кругов ада с тестированием и квест с выводом денег. Рассказыв...
ONYX: self-hosted мессенджер с LAN-режимом — история одного инди-проекта
Когда смотришь на существующие self-hosted мессенджеры, часто видишь одно из двух: либо сложную инфраструктуру, которую непросто развернуть (Matrix/Synapse), либо минимализм без...
UUI: Универсальная Пользовательская Дизайн-система для web
Как вырваться из замкнутого круга навязываемых акулами BigTech сомнительных технологий на простор устойчивого развития? Как сделать так, чтобы код внедряемой...
Множественная регрессия: Расширяем горизонты прогнозирования
Хотите научиться предсказывать продажи, цены на недвижимость или спрос на товары, учитывая сразу несколько факторов? Вам поможет множественная регрессия. В этой статье вы узнает...
FE-разработчики, перестаньте буквально воспринимать дизайн
50 итераций колесом мыши, чтобы просмотреть содержимое одного выпадающего списка. Это не баг — это фича Хабра и десятков других сайтов.
Линии сюжета
Рекламный слот
Article monetization slot
Reserved for contextual monetization inside article pages.
Похожие статьи
Еще материалы, которые пересекаются по тегам, источнику или категории.
DDD ASP.NET Почему не удобно для больших проектов с более чем 30 реестрами
Domain-Driven Design (DDD) звучит как серебряная пуля. Когда мы начинаем проект на ASP.NET, идея четкого разделения на слои, изоляция бизнес-логики в домене и использо...
Как я прошел ад публикации в App Store и Google Play и получил первые деньги
Я просто хотел выложить мобильное приложение и начать зарабатывать. В итоге – блокировка Google-аккаунта, несколько кругов ада с тестированием и квест с выводом денег. Рассказыв...
ONYX: self-hosted мессенджер с LAN-режимом — история одного инди-проекта
Когда смотришь на существующие self-hosted мессенджеры, часто видишь одно из двух: либо сложную инфраструктуру, которую непросто развернуть (Matrix/Synapse), либо минимализм без...
UUI: Универсальная Пользовательская Дизайн-система для web
Как вырваться из замкнутого круга навязываемых акулами BigTech сомнительных технологий на простор устойчивого развития? Как сделать так, чтобы код внедряемой...
Еще материалы от Habr
Свежие публикации и продолжение темы от той же редакции.
DDD ASP.NET Почему не удобно для больших проектов с более чем 30 реестрами
Domain-Driven Design (DDD) звучит как серебряная пуля. Когда мы начинаем проект на ASP.NET, идея четкого разделения на слои, изоляция бизнес-логики в домене и использо...
Как я прошел ад публикации в App Store и Google Play и получил первые деньги
Я просто хотел выложить мобильное приложение и начать зарабатывать. В итоге – блокировка Google-аккаунта, несколько кругов ада с тестированием и квест с выводом денег. Рассказыв...
ONYX: self-hosted мессенджер с LAN-режимом — история одного инди-проекта
Когда смотришь на существующие self-hosted мессенджеры, часто видишь одно из двух: либо сложную инфраструктуру, которую непросто развернуть (Matrix/Synapse), либо минимализм без...
UUI: Универсальная Пользовательская Дизайн-система для web
Как вырваться из замкнутого круга навязываемых акулами BigTech сомнительных технологий на простор устойчивого развития? Как сделать так, чтобы код внедряемой...