План/шаблон создания проектной документации?

Question

[raiboon]

Хочу в качестве тренировку составить полный пакет проектной и архитектурной документации для своего петпроджекта, как будто большой банк заказывает что-то у не менее большого аутсорсера.
С чего начать?

Answer 1

[Валентин]

ГОСТ 34 и ЕСПД
ПМИ есть всегда. Но вообще комплектность исполнительной документации часто согласовывается отдельно. Так, если разрабатываемая система каким-либо образом будет аттестовываться, то потребуется куча документации ИБ. Если система проходит под особым казначейским надзором, понадобится куча отчетной документации. Если информационная система разрабатывается по 223 ФЗ (вы же про банк спрашиваете?), потребуется свой комплект отчетности (например, проектно-сметная документация). В общем скажут, что сдавать надо.

Answer 2

[Саня Технадзор]

Вигерс - разработка требований к программному обеспечению (есть шаблоны)
Системное мышление (книга + курс) Левенчука - https://system-school.ru/levenchuk

Answer 3

[Иван Шумов]

С изучения существующих гостов по проектной документации. Они есть, их можно найти.

Лично я это избегаю по тому что подобная проектная документация устаревает быстрее чем создаётся

Comments

[Валентин]

Зря вы так, больше 30 лет не было значительных изменений.

[Иван Шумов]

Валентин, в чем?

[Валентин]

Иван Шумов, нормативка по документации.

[Иван Шумов]

Валентин, я говорю про документацию проекта, а не про госты. ГОСТы понятно что не меняются. Они здоровым людям не сдались

[Валентин]

Иван Шумов, значит не то заносите в проекты. Рабочая документация != проектная. В моих задачах проект не меняется до начала внедрения, а это может быть несколько лет. И все идёт согласно ГОСТам, СНиПам и законодательной нормативке (149, 152, 126, а если надо, то и 44, 223, 115 ФЗ). А как ещё вы внедрите и сдадите крупный сервис?

[Иван Шумов]

Валентин, как замечательно что я работаю далеко от госструктур и жёстких ограниченных доменных областей. Проекты для меня это уже продукты по тому что я занимаюсь архитектурой, а не просто разработкой

[Валентин]

Иван Шумов, вопрос не в госструктурах, а во взаимодействии софта с внешним миром) пока им люди не пользуются, нормативка не нужна. Надо сделать информационную вывеску на улице или какое-нибудь табло - привет, нормативка. Надо в конце-концов ЦОД сделать - опять привет законодательство. Канал связи - опять она здесь. Да даже сайт сделать - по-хорошему есть ГОСТ для людей с ограниченными возможностями. Сервис сделать с возможностью приема платежей, привет, 54ФЗ.

А архитектура - понятие до конца не определенное, каждый по своему трактует, каждый своё вкладывает.

[Иван Шумов]

Валентин, все вполне определено)

[Валентин]

Иван Шумов, кем и как? Я вот читаю TOGAF- там одно определение, читаю ГОСТ/ISO - другое, смотрю вакансии - каждый своё лепит. Есть ещё куча сайтиков типа scaled agile framework и каких-то ещё, пытающихся ввести свои ситуативные определения.

[Иван Шумов]

Валентин, togaf это узконаправленный Фреймворк, не более. На данный момент есть всего одна организация, выпускающая и обучающая архитекторов разных направлений и это IASA. Стоит ознакомиться с их ITABoK. На данный момент выпущена третья редакция, но пока в draft. Хотя ошибки там, в основном, орфографические

[Валентин]

Иван Шумов,

Проекты для меня это уже продукты по тому что я занимаюсь архитектурой, а не просто разработкой

Кстати, если вы так утверждаете, значит вы как минимум работаете с нормативкой в виде налогового кодекса, фискализацией платежей, оценкой качества оказываемых услуг (показатели эффективности как раз вписываются в проект).

[Иван Шумов]

Валентин, слава богу что у меня всегда есть люди, берущие черную работу на себя

[Валентин]

Иван Шумов, чёрная работа - это непосредственная разработка. Но до разработки надо указать, что это надо разрабатывать и с этим надо интегрироваться. Кроме того, кто-то должен предлагать решения (часто финансово значимые), чтобы идти по определенному пути.

На данный момент есть всего одна организация, выпускающая и обучающая архитекторов разных направлений и это IASA.

Как минимум есть TOGAF и Cisco Arch. А считать их узконаправленнвми или нет - ваша воля. Я вот считаю ITABOK всего лишь частью TOGAF, только до внедрения системы. Он хорошо покрывает только этап подготовки и контроля выполнения технического задания.

[Иван Шумов]

Валентин, TOGAF это только Enterprise Architecture, увы. Направлений же у архитектуры валом. Cisco ARCH это вообще только networking и только про Cisco. Какая там архитектура, алло?

[mindgrow]

Архитектор решений избегает писать документацию...
А чем вы занимаетесь?

[Иван Шумов]

mindgrow, документация по существующим гостам не является полезным инструментом просто. Нормальная документация пишется в Confluence тоннами на постоянной основе