Алтай
Документация к продукту. Как упорядочить этот хаос.
Мы часто сталкиваемся с отсутствием документации к продукту, программе или если она и есть, но настолько непонятная и не полная, что читать ее бесполезно. Сегодня я постараюсь описать процесс создания вменяемой документации на созданный вами программный продукт. Документации для пользователя и для программистов, зацепим все аспекты. Букв будет много, тема большая. Для написания документации на продукт можно обратиться к стандартам, где на сегодня есть два типа: ГОСТы — это нечто, что разрабатывалось при Советском Союзе, их слишком много...
Список ГОСТов ЕСКД
ЕСКД - это Единая Система Конструкторской Документации. Это набор российских стандартов (ГОСТов), которые устанавливают взаимосвязанные правила и положения по порядку разработки, оформления и обращения (движения) конструкторской документации, которая создаётся и/или применяется на предприятии. Если вы занимаетесь разработкой программного обеспечения, то вам это, может, и не надо. Но если вы имеете хоть какое-то отношение к чертежам, к производству, то знать ЕСКД надо. Даже если вы, например, инженер в области автоматизации...