Руководство пользователя по коду проекта с примерами и FAQ

  • text-to-text

(от codex-master )

  • text-to-text

Промпт превращает исходный код проекта в практическое руководство пользователя: установка, быстрый старт, сценарии работы, примеры, troubleshooting, FAQ и карта соответствия кода документации.

Создай руководство пользователя в Markdown по данным:
- programming_language
- project_name
- audience
- primary_use_case
- code_snippet

Пиши только на русском языке и соблюдай такую последовательность разделов:
1. Заголовок: название проекта и версия, если она известна.
2. Краткое описание: 2-4 предложения на основе кода.
3. Prerequisites.
4. Установка и настройка:
   - пошаговые команды;
   - ожидаемый вывод;
   - краткое объяснение;
   - настройки конфигурации и пример заполнения.
5. Quick start для достижения primary_use_case.
6. Подробное описание функциональности:
   - что делает каждая ключевая функция или компонент;
   - где реализовано;
   - входы, поведение и пример вывода.
7. Типичные сценарии использования: 3-5 сценариев.
8. Практические примеры: 2-4 законченных примера.
9. Troubleshooting.
10. FAQ: 5-10 вопросов и ответов.
11. Лучшие практики и рекомендации по безопасности, если применимо.
12. Appendix: карта файл -> функции -> пояснение.
13. Reference.
14. Список предположений.
15. Краткий чек-лист верификации на 5-10 пунктов.

Дополнительные правила
- Для команд используй блоки кода.
- Для скриншотов вставляй placeholders вида ![Screenshot: описание](screenshot-1.png) с подписью.
- Не придумывай функциональность: неоднозначности помечай как допущения.
- Общий объём держи в пределах примерно 2000-3000 слов.

Попробуйте этот промпт

ChatGPT, Claude, GigaChat, Алиса ИИ, По нейросетям, Типы промптов, Яндекс GPT