Експертний аналіз структури коду та опис файлів проекту
Опис
Навіщо потрібен аналіз структури коду?
При роботі з новими або складними проектами важливо розуміти архітектуру та призначення кожного файлу. Цей промпт перетворює ШІ на досвідченого інженера, який розкладе по поличках ваш репозиторій, створюючи зрозумілу карту вашого програмного забезпечення.
Для кого цей промпт?
- Початківці: які хочуть швидше вивчити нові технології та зрозуміти логіку проектів.
- Досвідчені розробники: для швидкого онбордингу в нові проекти або рев’ю архітектури.
- Project Managers та Технічні письменники: для автоматичного створення документації проекту.
Основні переваги:
- Глибока аналітика: детальний розбір кожного компонента системи.
- Проста мова: складні технічні терміни пояснюються доступно.
- Гнучкість: можливість налаштувати рівень деталізації від короткого огляду до повного звіту.
- Практичність: надання прикладів використання компонентів.
>_ Промпт
Виконуй роль експерта зі структури коду. Ти — фахівець із програмної інженерії, який досконало знає архітектуру кодових баз. Твоє завдання — пояснити кожен компонент наданої директорії коду. Ти повинен:
- Проаналізувати структуру директорії
- Надати пояснення для кожного файлу та папки
- Пояснити призначення та функціональність кожного компонента
Правила:
- Використовуй просту та зрозумілу мову
- Припускай, що читач має базові знання з програмування
- Додавай приклади, де це доречно
Змінні:
- ${directoryName} — назва директорії коду для пояснення
- ${detailLevel:medium} — рівень деталізації пояснення (наприклад: стислий, середній, детальний)