реклама
разместить

Бессмертный код или Скрижаль синьора

Эта статья будет интересна программистам, которые уважают собственный труд.

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

Вся информация помещается в отдельный документ. Скрижаль не заменяет комментарии в коде, а всесторонне дополняет их. Большинство артефактов должны иметь собственную уникальную метку, помещенную в комментариях к коду.

Структура документа

Контекст

  • Входные требования, ограничения, правила
  • Решения, определенные заказчиком
  • Решения и выводы, полученные в результате анализа задачи
  • Входные спецификации
    Структуры, форматы, объекты и знания о них.
  • Прочие знания
  • Долг
    Что не реализовано или планируется переделать.

Код

  • Общий план решения
    Рекомендуется излагать план решения в текстовом виде.
  • Выходные спецификации
    Структуры, форматы, объекты и знания о них (трактовки, нюансы применения).
  • Промежуточные спецификации, использованные в коде
    Структуры, форматы, объекты и знания о них.
  • Прочие знания
  • Долг
    Что не реализовано или планируется переделать.

Прочие моменты

В случае необходимости используете декомпозицию артефактов.

Разделы структуры не являются обязательными и используются только при необходимости.

Рекомендуется использовать для средних и сложных решений.

Если качества и объема информации достаточно, чтобы ИИ смог написать годный код, то цель достигнута.

реклама
разместить
Начать дискуссию
Разработка IT-продукта в 2025: как сэкономить минимум в 2 раза и запустить проект без классических ошибок — 7 проверенных шагов
Разработка IT-продукта в 2025: как сэкономить минимум в 2 раза и запустить проект без классических ошибок — 7 проверенных шагов
44
реклама
разместить
Scrum на минималках или как обойтись без редкого специалиста. Личный опыт project менеджера

Мягкие методологии управления проектами ворвались в сердца и умы работодателей. Без знания Agile, как на кривой козе, - не подъезжай на работу. Что делать, если на проекте даже техлида нет, а о Scrum мастере речь вообще не идет? Как всегда - разбираемся сами. Будь как Scrum - гибким и самоорганизованным.

новости от OpenAI! GPT 4.5 для всех!
новости от OpenAI! GPT 4.5 для всех!

Plus-подписчикам начали выдавать доступ к модели GPT-4.5, но не всем сразу – запуск планируется в течение 1–3 дней.

11
Эти промты помогают мне в программировании каждый день

Искусственный интеллект становится незаменимым помощником для программистов, помогая решать задачи быстрее, находить ошибки и даже придумывать новые решения. Для этого достаточно использовать текстовые запросы — или промты — которые направляют ИИ на выполнение определенных действий. В этой статье я расскажу о промтах, которые стали моими ежедневным…

Эти промты помогают мне в программировании каждый день
22
Чистая архитектура фронтенд приложений. Часть первая

Предисловие

Декомпозиция задач: Как сделать проекты управляемыми и успешными — for Business analyst, Scrum master, Project Managers! 🏆💪💥

Декомпозиция задач — это процесс разбивки сложной задачи или проекта на более мелкие, управляемые и понятные подзадачи. Этот подход позволяет упростить выполнение задачи, сделать её более структурированной и снизить уровень стресса, связанного с её выполнением.

1010
22
4 способа оценки рынка и фишки для качественных опросов: как я оценила рынок инвестиций в Малайзии

Привет, я Аня Авинская, лид маркетинга в Garage Eight. В прошлом году я выступила на конференции по маркетинговой аналитике Матемаркетинг 2024. На примере Малайзии рассказала, как посчитать объем рынка, когда данные в сети найти сложно. Поняла, что тема очень живая, поэтому делюсь лайфхаками, методами и результатами.

4 способа оценки рынка и фишки для качественных опросов: как я оценила рынок инвестиций в Малайзии
22
11
Как и зачем мы используем чек-листы в работе

Всем привет, я — Саша Комбаров, CEO в Пиробайт. Мы разрабатываем сервисы и мобильные приложения. А еще делимся документами для диджитал: https://t.me/regulations_pyro_bot

Как и зачем мы используем чек-листы в работе
1313
11
[]