* Translate bug_report.md via GitLocalize * Translate CHANGELOG.md via GitLocalize * Translate CHANGELOG.md via GitLocalize * Translate CODEBASE_STRUCTURE.md via GitLocalize * Translate CODEBASE_STRUCTURE.md via GitLocalize * Translate CODE_OF_CONDUCT.md via GitLocalize * Translate CODE_OF_CONDUCT.md via GitLocalize * Translate CODING_GUIDELINES.md via GitLocalize * Translate TODO.md via GitLocalize * Translate PULL_REQUEST_TEMPLATE.md via GitLocalize * Translate CONTRIBUTING.md via GitLocalize * Translate Hackathon.md via GitLocalize * Translate Hackathon.md via GitLocalize * Translate Bot.md via GitLocalize * Translate Bot.md via GitLocalize * Translate Minimal.md via GitLocalize * Translate Minimal.md via GitLocalize * Translate Standard.md via GitLocalize * Translate Standard.md via GitLocalize * Translate feature_request.md via GitLocalize * Translate custom.md via GitLocalize * Update CONTRIBUTING.md * Update custom.md * Update bug_report.md * Update feature_request.md * Update Minimal.md * Update Standard.md Co-authored-by: mt-gitlocalize <mt@gitlocalize.com>
6.2 KiB
Название Проекта
Несколько строк, описывающих ваш проект.
📝 Содержание
- Постановка задачи
- Идея/Решение
- Зависимости/Ограничения
- Планы на будущее
- Настройка локальной среды
- Применение
- Стек технологий
- Участие
- Авторы
- Благодарности
🧐 Постановка задачи
При написании постановки задачи полезно разработать и придерживаться определенного формата. Хотя для этого есть несколько вариантов, ниже представлен простой и понятный шаблон, который часто используется в бизнес-аналитике, чтобы сосредоточиться на определении проблемы.
- ИДЕАЛЬНО: Этот раздел используется для описания желаемого или «будущего» состояния процесса или продукта. В целом этот раздел должен проиллюстрировать, как будет выглядеть ожидаемая среда после реализации решения.
- РЕАЛЬНОСТЬ: Этот раздел используется для описания текущего или «как есть» состояния процесса или продукта.
- ПОСЛЕДСТВИЯ. Этот раздел используется для описания воздействия на бизнес, если проблема не будет устранена или улучшена. Сюда входят затраты, связанные с потерей денег, времени, производительности, конкурентного преимущества и т.д.
Следование этому формату приведет к созданию работоспособного документа, который можно использовать для понимания проблемы и выявления требований, которые приведут к выигрышному решению.
💡 Идея / Решение
Этот раздел используется для описания возможных решений.
После того, как разделы об идеале, реальности и последствиях завершены и поняты, становится проще найти решение проблемы.
⛓️ Зависимости / ограничения
- Каковы зависимости вашего проекта?
- Опишите каждое ограничение подробно, но кратко
- Объясните, почему существует каждое ограничение
- Укажите причины, по которым каждое ограничение не может быть преодолено с помощью метода(ов), выбранного для приобретения
- Оцените влияние каждого ограничения на общие результаты и выводы вашего проекта и, если это уместно, опишите, как эти ограничения могут указывать на необходимость дальнейших исследований.
🚀 Планы на будущее
Напишите о том, чего вы не смогли разработать в ходе Хакатона; и о том, чего может достичь ваш проект в будущем.
🏁 Начало работы
Эти инструкции позволят вам запустить копию проекта на локальном компьютере в целях разработки и тестирования. К ак развернуть проект в действующей системе описано в разделе Развертывание.
Предпосылки
Что нужно для установки программного обеспечения и как их установить.
Give examples
Установка
Пошаговая серия примеров, рассказывающих, как запустить среду разработки.
Скажите, какой будет шаг
Give the example
И повторить
until finished
🎈 Использование
Добавьте примечания о том, как использовать систему.
⛏️ Стек технологий
✍️ Авторы
- @kylelobo — Идея и начальная работа
Список участников, работавших в этом проекте.
🎉 Благодарности
- Спасибо всем, чей код использовался
- Вдохновение
- Ссылки