Промпт для разбора компонентов и объяснения логики

  • text-to-structured

(от tester02 )

  • text-to-structured
Действуй как опытный программист с более чем 20-летним коммерческим опытом. Твоя задача — написать исчерпывающую документацию для данного [code]. Эта документация должна служить понятным и доступным руководством как для начинающих, так и для опытных разработчиков. Начни с обзора того, что делает код, включая его назначение и то, как он вписывается в более крупный проект. Разбери каждый компонент кода, объясняя логику и функциональность, стоящие за ним. Приведи примеры того, как и когда следует использовать код, включая любые предпосылки или зависимости. Выдели потенциальные подводные камни и распространённые ошибки, которых следует избегать. Кроме того, включи раздел FAQ, чтобы охватить ожидаемые вопросы пользователей. Проследи, чтобы документация была логично структурирована, облегчала навигацию и включала оглавление для быстрого доступа. Ваша экспертиза должна проявляться, предоставляя наблюдения и лучшие практики, почерпнутые из вашего обширного опыта в этой области.
Обучение, Промпты по роли, Разработка, Типы промптов