mirror of
https://github.com/kylelobo/The-Documentation-Compendium.git
synced 2025-09-02 17:42:57 +02:00
Add translate to Russian (#39)
* 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>
This commit is contained in:
@@ -0,0 +1,43 @@
|
||||
# Изменения
|
||||
|
||||
Все заметные изменения в этом проекте будут записаны в этом файле.
|
||||
|
||||
Формат основан на [Как логировать изменения](http://keepachangelog.com/) и этот проект придерживается [семантического управления версиями](http://semver.org/).
|
||||
|
||||
## [Неизданные] - гггг-мм-дд
|
||||
|
||||
Здесь мы пишем заметки об обновлениях для брендов. Это командное усилие, чтобы сделать их как можно более простыми.
|
||||
|
||||
### Добавили
|
||||
|
||||
- [ИМЯПРОЕКТА-XXXX ](http://tickets.projectname.com/browse/PROJECTNAME-XXXX) НЕЗНАЧИТЕЛЬНОЕ Здесь должно быть название задачи.
|
||||
- [ИМЯПРОЕКТА-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY) ИСПРАВЛЕНИЕ Здесь должно быть название задачи.
|
||||
|
||||
### Изменили
|
||||
|
||||
### Исправили
|
||||
|
||||
## [1.2.4] - 15.03.2017
|
||||
|
||||
Шаги по обновлениям в 1.2.4, которым люди должны следовать.
|
||||
|
||||
### Добавили
|
||||
|
||||
### Изменили
|
||||
|
||||
- [ИМЯПРОЕКТА-ZZZZ](http://tickets.projectname.com/browse/PROJECTNAME-ZZZZ) ИСПРАВЛЕНИЕ Drupal.org теперь используется для компоновщика.
|
||||
|
||||
### Исправили
|
||||
|
||||
- [ИМЯПРОЕКТА-TTTT](http://tickets.projectname.com/browse/PROJECTNAME-TTTT) ИСПРАВИЛИ Добавили логику к удалению тизера рабочего листа, чтобы удалить соответствующие карточки расписания.
|
||||
|
||||
## [1.2.3] - 14.03.2017
|
||||
|
||||
### Добавили
|
||||
|
||||
### Изменили
|
||||
|
||||
### Исправили
|
||||
|
||||
- [ИМЯПРОЕКТА-UUUU](http://tickets.projectname.com/browse/PROJECTNAME-UUUU) НЕЗНАЧИТЕЛЬНОЕ Исправлен модуль foo tests.
|
||||
- [ИМЯПРОЕКТА-RRRR](http://tickets.projectname.com/browse/PROJECTNAME-RRRR) ВАЖНОЕ Модуль Foo использует часовой пояс браузера для выбора даты.
|
||||
|
@@ -0,0 +1,41 @@
|
||||
Это каталоги, которые мы активно используем в разработке:
|
||||
|
||||
- [frontend/server/controllers](https://github.com/kylelobo/The-Documentation-Compendium/tree/master/frontend/server/controllers): Контроллеры выполняют бизнес-логику и предоставляют серверный API.
|
||||
- [frontend/server/libs](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs): Библиотеки и утилиты.
|
||||
- [frontend/server/libs/dao](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs/dao): Data Access Objects [DAO] и Value Objects [VO]. Классы, используемые для представления схем базы данных и облегчения их использования контроллерами.
|
||||
- [frontend/templates](https://github.com/The-Documentation-Compendium/tree/master/frontend/templates): Шаблоны Smarty для создания HTML-кода, который отображается пользователям.
|
||||
- [frontend/www](https://github.com/The-Documentation-Compendium/tree/master/frontend/www): Полное содержание Интернет-страницы.
|
||||
|
||||
### Фронтенд / www
|
||||
|
||||
Содержание:
|
||||
|
||||
- js /
|
||||
- css /
|
||||
|
||||
#### js
|
||||
|
||||
Как следует из названия, здесь находятся все шрифты javascript и фреймворки javascript. Если вы хотите внести изменения, уменьшите javascript, а затем загрузите.
|
||||
|
||||
#### css
|
||||
|
||||
Как и в случае с js, тут уменьшенные файлы css.
|
||||
|
||||
### Фронтенд / сервер
|
||||
|
||||
Содержание:
|
||||
|
||||
- dao /
|
||||
- контроллеры /
|
||||
|
||||
Ни один из этих модулей не должен быть доступен внешнему миру. Единственное, что может их вызвать — это пользовательский интерфейс. Вот почему они находятся в папке www.
|
||||
|
||||
#### DAO / VO
|
||||
|
||||
Папка *dao* содержит классы для уровня доступа к данным. Он должен знать 2 вещи: *data access objects* и *value objects*. *Value objects*(VO) — это не что иное, как классы, которые сопоставляются непосредственно с каждой таблицей в базе данных. Поэтому там есть как класс под названием Users, так и таблица с тем же именем. Этот класс имеет свои сеттеры и геттеры для каждого поля в базе данных. * Data access objects*(dao) — являются статическими классами для каждой из таблиц, они служат для получения и создания постоянных объектов *vo*.
|
||||
|
||||
[Вот больше информации об этой модели](http://www.ibm.com/developerworks/java/library/j-dao/)
|
||||
|
||||
#### Контроллеры
|
||||
|
||||
Контроллеры — это то место, где принимаются решения. Контроллер использует dao и vo для принятия решений и никогда не вызывает базу данных напрямую. Таким образом, мы избегаем использования отдельных контроллеров для каждого модуля проекта.
|
||||
|
@@ -0,0 +1,48 @@
|
||||
# Кодекс поведения участников Соглашения
|
||||
|
||||
## Наше обещание
|
||||
|
||||
В интересах создания открытой и доброжелательной среды мы, как участники и сопровождающие, обязуемся сделать участие в нашем проекте и нашем сообществе свободным от преследований для всех, независимо от возраста, размера тела, инвалидности, этнической принадлежности, половых характеристик, гендерной идентичности, самовыражение, уровеня опыта, образования, социально-экономического статус, национальности, внешнего вида, расы, религии или сексуальной идентичности и ориентации.
|
||||
|
||||
## Наши стандарты
|
||||
|
||||
Примеры поведения, которое способствует созданию благоприятной среды, включают:
|
||||
|
||||
- Использование приветливого и инклюзивного языка
|
||||
- Уважительное отношение к различным точкам зрения и опыту
|
||||
- Изящно принимаю конструктивную критику
|
||||
- Сосредоточение внимания на том, что лучше для сообщества
|
||||
- Проявление сочувствия к другим членам сообщества
|
||||
|
||||
Примеры недопустимого поведения участников включают:
|
||||
|
||||
- Использование сексуализированной лексики или образов и нежелательное сексуальное внимание или заигрывания
|
||||
- Троллинг, оскорбительные / уничижительные комментарии, а также личные или политические нападки
|
||||
- Публичное или частное преследование
|
||||
- Публикация частной информации других лиц, такой как физический или электронный адрес, без явного разрешения
|
||||
- Другое поведение, которое можно обоснованно считать неуместным в профессиональной среде.
|
||||
|
||||
## Наши обязанности
|
||||
|
||||
Сопровождающие проекта несут ответственность за разъяснение стандартов приемлемого поведения и от них ожидают принятия соответствующих и справедливых корректирующих действий в ответ на любые случаи неприемлемого поведения.
|
||||
|
||||
Сопровождающие проекта имеют право и обязаны удалять, редактировать или отклонять комментарии, коммиты, код, правки вики, проблемы и другие материалы, которые не соответствуют настоящему Кодексу поведения, или временно или навсегда заблокировать любого участника за другое поведение, которое они считают неуместным, угрожающим, оскорбительным или вредным.
|
||||
|
||||
## Сфера
|
||||
|
||||
Этот Кодекс поведения применяется как в проектных, так и в общественных местах, когда человек представляет проект или его сообщество. Примеры представления проекта или сообщества включают использование официального адреса электронной почты проекта, размещение сообщений через официальную учетную запись в социальных сетях или выполнение функций назначенного представителя на онлайн- или офлайн-мероприятии. Представление проекта может быть дополнительно определено и уточнено сопровождающими проекта.
|
||||
|
||||
## Исполнение
|
||||
|
||||
О случаях оскорбления, преследования или иного недопустимого поведения можно сообщить, связавшись с командой проекта по адресу kylelobo20@gmail.com. Все жалобы будут рассмотрены и исследованы, и в результате будет дан ответ, который будет сочтен необходимым и соответствующим обстоятельствам. Команда проекта обязана сохранять конфиденциальность в отношении лица, сообщившего об инциденте. Более подробная информация о конкретных правилах применения может быть опубликована отдельно.
|
||||
|
||||
Сопровождающие проекта, которые не соблюдают и не соблюдают Кодекс поведения добросовестно, могут столкнуться с временными или постоянными последствиями, как это определено другими членами руководства проекта.
|
||||
|
||||
## Атрибуция
|
||||
|
||||
Этот Кодекс поведения адаптирован из [Соглашения для авторов], версия 1.4, доступного по адресу https://www.contributor-covenant.org/version/1/4/code-of-conduct.html.
|
||||
|
||||
Ответы на распространенные вопросы об этом кодексе поведения см. https://www.contributor-covenant.org/faq.
|
||||
|
||||
|
||||
[Соглашения для авторов]: https://www.contributor-covenant.org
|
@@ -0,0 +1,24 @@
|
||||
# Гайдлайн по написанию кода
|
||||
|
||||
- Вы можете проверить, соответствует ли ваш код этому гайдлайну, запустив `stuff/php-format.py validate`
|
||||
- Табуляция, без пробелов
|
||||
- Конец строки должен быть в стиле Unix (`\n`), а не в стиле Windows (`\r\n`)
|
||||
- Открывающие скобки находятся в той же строке, что и последний оператор.
|
||||
|
||||
```
|
||||
if (condition) {
|
||||
stuff;
|
||||
}
|
||||
```
|
||||
|
||||
- Пробел между ключевыми словами и круглыми скобками для: `if`, `else`, `while`, `switch`, `catch`, `function`
|
||||
- В вызовах функций нет пробела перед круглыми скобками
|
||||
- В скобках нет пробелов
|
||||
- Пробел после каждой запятой, но без пробела перед
|
||||
- Все бинарные операторы должны иметь один пробел до и один после
|
||||
- Не должно быть более одной непрерывной пустой строки
|
||||
- Пустых комментариев быть не должно
|
||||
- Вы не должны использовать блоки комментариев `/ * ... * /`, только строку `// ...`
|
||||
- Изменения в функциональности должны сопровождаться соответствующими новыми/ модифицированными тестами
|
||||
- Исключения должны использоваться для сообщения об ошибочных состояниях. Использование функций, возвращающих true/false, разрешено, когда они являются ожидаемыми значениями
|
||||
- При необходимости используйте [RAII] (http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization), в основном при администрировании ресурсов (файлов и т. д.)
|
||||
|
@@ -0,0 +1,41 @@
|
||||
# Руководство по участию
|
||||
|
||||
- Пополнить The Documentation Compendium довольно просто. В этом документе показано, как начать работу
|
||||
|
||||
## Общее
|
||||
|
||||
- [Структура кодовой базы ](./CODEBASE_STRUCTURE.md) содержит подробную информацию о том, как структурированы различные файлы в этом проекте
|
||||
- Пожалуйста, убедитесь, что любые внесенные вами изменения соответствуют [Гайдлайну по написанию кода](./CODING_GUIDELINES.md) этого репозитория
|
||||
|
||||
## Отправка изменений
|
||||
|
||||
- Сделайте форк репозитория
|
||||
- [https://github.com/kylelobo/The-Documentation-Compendium/fork](https://github.com/kylelobo/The-Documentation-Compendium/fork)
|
||||
- Проверьте новую ветку и назовите ее в соответствии с тем, что вы собираетесь делать:
|
||||
- Пример:
|
||||
```
|
||||
$ git checkout -b BRANCH_NAME
|
||||
```
|
||||
Если вы получите сообщение об ошибке, вам может потребоваться сначала получить fooBar, используя
|
||||
```
|
||||
$ git remote update && git fetch
|
||||
```
|
||||
- Используйте одну ветку для каждого исправления / добавления
|
||||
- Закоммитьте свои изменения
|
||||
- Пожалуйста, предоставьте git сообщение, объясняющее, что вы сделали
|
||||
- Пожалуйста, убедитесь, что ваши коммиты соответствуют [соглашениям](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md)
|
||||
- Закоммите в репозитории
|
||||
- Пример:
|
||||
```
|
||||
$ git commit -am 'Add some fooBar'
|
||||
```
|
||||
- Запуште в ветку
|
||||
- Пример:
|
||||
```
|
||||
$ git push origin BRANCH_NAME
|
||||
```
|
||||
- Сделать пул реквест
|
||||
- Убедитесь, что вы отправили пул реквест в ветку <code>fooBar</code>
|
||||
- Travis CI наблюдает за тобой!
|
||||
|
||||
Если вы будете следовать этим инструкциям, ваш пул реквест довольно безопасно попадет в основной репозиторий!
|
||||
|
@@ -0,0 +1,35 @@
|
||||
---
|
||||
Имя: Отчет об ошибке
|
||||
О чем: Создайте отчет, который поможет нам стать лучше
|
||||
Заголовок:
|
||||
Лэйблы:
|
||||
Исполнители:
|
||||
---
|
||||
|
||||
**Опишите ошибку** Четкое и краткое описание ошибки.
|
||||
|
||||
**Как воспроизвести** Шаги для воспроизведения:
|
||||
|
||||
1. Перейдите к '...'
|
||||
2. Нажмите на '....'
|
||||
3. Прокрутите вниз до "...."
|
||||
4. Увидите ошибку
|
||||
|
||||
**Ожидаемое поведение** Четкое и краткое описание того, что вы ожидали.
|
||||
|
||||
**Скриншоты** Если возможно, добавьте скриншоты, которые помогут объяснить вашу проблему.
|
||||
|
||||
**<strong>Компьютер (заполните следующую информацию):</strong>**
|
||||
|
||||
- ОС: [например, iOS]
|
||||
- Браузер [например, Chrome, Safari]
|
||||
- Версия [например, 22]
|
||||
|
||||
**<strong>Смартфон (заполните следующую информацию):</strong>**
|
||||
|
||||
- Устройство: [например, iPhone6]
|
||||
- ОС: [например, iOS8.1]
|
||||
- Браузер [например, стандартный браузер, Safari]
|
||||
- Версия [например, 22]
|
||||
|
||||
**Дополнительный контекст** Добавьте сюда дополнительную информацию о проблеме.
|
||||
|
@@ -0,0 +1,7 @@
|
||||
---
|
||||
Имя: Шаблон задачи
|
||||
О чем: Опишите здесь цель этого шаблона задачи.
|
||||
Заголовок:
|
||||
Лэйблы:
|
||||
Исполнители:
|
||||
---
|
||||
|
@@ -0,0 +1,15 @@
|
||||
---
|
||||
Имя: Предложение
|
||||
О чем: Предложите идею для этого проекта
|
||||
Заголовок:
|
||||
Лэйблы:
|
||||
Исполнители:
|
||||
---
|
||||
|
||||
**Связано ли ваше предложение с проблемой? Пожалуйста, опишите.** Четкое и краткое описание проблемы. Пример: Я всегда расстраиваюсь, когда [...]
|
||||
|
||||
**Ожидаемое поведение** Четкое и краткое описание того, что вы ожидали.
|
||||
|
||||
**Опишите альтернативы, которые вы рассмотрели.** Четкое и краткое описание любых альтернативных решений или возможностей, которые вы рассмотрели.
|
||||
|
||||
**Дополнительный контекст** Добавьте сюда любой другой контекст или скриншоты.
|
||||
|
@@ -0,0 +1,14 @@
|
||||
### Ваш чек-лист для пул реквеста
|
||||
|
||||
🚨 Пожалуйста, ознакомьтесь с принципами по внесению изменений в этот репозиторий.
|
||||
|
||||
- [ ] Убедитесь, что вы запрашиваете пул реквест для ветки темы/возможности/исправления ошибок (справа). Не запрашивайте для ветки мастер!
|
||||
- [ ] Убедитесь, что вы делаете запрос на пул реквест для ветки fooBar (слева).
|
||||
- [ ] Проверьте, что стили сообщений коммита или даже всех коммитов соответствуют нашей запрошенной структуре.
|
||||
- [ ] Проверьте, что ваши изменения пройдут проверку линтинга кода и юнит-тестирование.
|
||||
|
||||
### Описание
|
||||
|
||||
Пожалуйста, опишите свой пул реквест.
|
||||
|
||||
❤️ Спасибо!
|
||||
|
@@ -0,0 +1,132 @@
|
||||
<p align="center"><a href="" rel="noopener"> </a><img width="200px" height="200px" src="https://i.imgur.com/FxL5qM0.jpg" alt="Логотип бота"></p>
|
||||
|
||||
<h3 align="center">Имя бота</h3>
|
||||
|
||||
<div align="center">
|
||||
</div>
|
||||
|
||||
[]()
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
<p align="center">🤖 Несколько строк, описывающих, что делает ваш бот.<br></p>
|
||||
|
||||
## 📝 Содержание
|
||||
|
||||
- [О боте](#about)
|
||||
- [Демо/Работа](#demo)
|
||||
- [Как это устроено](#working)
|
||||
- [Применение](#usage)
|
||||
- [Начало работы](#getting_started)
|
||||
- [Развертывание собственного бота](#deployment)
|
||||
- [Построен с использованием](#built_using)
|
||||
- [To Do](../TODO.md)
|
||||
- [Участие](../CONTRIBUTING.md)
|
||||
- [Авторы](#authors)
|
||||
- [Благодарности](#acknowledgement)
|
||||
|
||||
## 🧐 <a name="about">О боте</a>
|
||||
|
||||
Напишите примерно 1-2 абзаца, описывающих назначение вашего бота.
|
||||
|
||||
## 🎥 Демо / Работа<a name="demo"></a>
|
||||
|
||||

|
||||
|
||||
## 💭 Как это работает<a name="working"></a>
|
||||
|
||||
Бот сначала извлекает слово из комментария, а затем извлекает определения слова, часть речи, пример и источник из Oxford Dictionary API.
|
||||
|
||||
Если этого слова нет в Оксфордском словаре, Oxford API возвращает ответ 404, после чего бот пытается получить результаты из API Urban Dictionary.
|
||||
|
||||
Бот использует Pushshift API для получения комментариев, модуль PRAW для ответа на комментарии и Heroku в качестве сервера.
|
||||
|
||||
Весь бот написан на Python 3.6.
|
||||
|
||||
## 🎈 Использование<a name="usage"></a>
|
||||
|
||||
Чтобы использовать бот, введите:
|
||||
|
||||
```
|
||||
!dict word
|
||||
```
|
||||
|
||||
Первая часть, т.е. "!dict", **не** чувствительна к регистру.
|
||||
|
||||
Затем бот предоставит вам определение слова в Оксфордском словаре (или Urban Dictionary, если слово не существует в Оксфордском словаре) в качестве ответа на комментарий.
|
||||
|
||||
### Пример:
|
||||
|
||||
> !dict что такое любовь
|
||||
|
||||
**Определение:**
|
||||
|
||||
Детка, не делай мне больно ~ Не делай мне больно ~ больше.
|
||||
|
||||
**Пример:**
|
||||
|
||||
Чувак1: Бро, что такое любовь? Чувак2: Детка, не делай мне больно, не больно мне больше! Чувай1: Чего?
|
||||
|
||||
**Источник:** https://www.urbandictionary.com/define.php?term=what%20is%20love.
|
||||
|
||||
---
|
||||
|
||||
<sup>Бип-буп. Я бот. Если есть какие-либо вопросы, свяжитесь с моим <a href="https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot">Мастером</a></sup>
|
||||
|
||||
<sup>Хотите сделать похожего бота на Reddit? Проверьте: <a href="https://github.com/kylelobo/Reddit-Bot">GitHub</a></sup>
|
||||
|
||||
## 🏁 Начало работы<a name="getting_started"></a>
|
||||
|
||||
Эти инструкции позволят вам запустить копию проекта на локальном компьютере в целях разработки и тестирования. К ак развернуть проект в действующей системе описано в разделе [Развертывание](#deployment).
|
||||
|
||||
### Предпосылки
|
||||
|
||||
Что нужно для установки программного обеспечения и как их установить.
|
||||
|
||||
```
|
||||
Give examples
|
||||
```
|
||||
|
||||
### Установка
|
||||
|
||||
Пошаговая серия примеров, рассказывающих, как запустить среду разработки.
|
||||
|
||||
Скажите, какой будет шаг
|
||||
|
||||
```
|
||||
Give the example
|
||||
```
|
||||
|
||||
И повторить
|
||||
|
||||
```
|
||||
until finished
|
||||
```
|
||||
|
||||
Закончите примером получения некоторых данных из системы или использования их для небольшой демонстрации.
|
||||
|
||||
## 🚀 Развертывание собственного бота<a name="deployment"></a>
|
||||
|
||||
Чтобы увидеть пример проекта по развертыванию бота, просмотрите мою собственную конфигурацию:
|
||||
|
||||
- **Heroku** : https://github.com/kylelobo/Reddit-Bot#deploying_the_bot
|
||||
|
||||
## ⛏️ Построен с использованием<a name="built_using"></a>
|
||||
|
||||
- [PRAW](https://praw.readthedocs.io/en/latest/) — Python Reddit API Wrapper
|
||||
- [Heroku](https://www.heroku.com/) —хостинговая платформа SaaS
|
||||
|
||||
## ✍️ Авторы<a name="authors"></a>
|
||||
|
||||
- [@kylelobo](https://github.com/kylelobo) — Идея и начальная работа
|
||||
|
||||
Список [участников](https://github.com/kylelobo/The-Documentation-Compendium/contributors), работавших в этом проекте.
|
||||
|
||||
## 🎉 Благодарности<a name="acknowledgement"></a>
|
||||
|
||||
- Спасибо всем, чей код использовался
|
||||
- Вдохновение
|
||||
- Ссылки
|
||||
|
@@ -0,0 +1,106 @@
|
||||
<p align="center"><a href="" rel="noopener"> </a><img src="https://i.imgur.com/AZ2iWek.png" alt="Логотип проекта"></p>
|
||||
<h3 align="center">Название Проекта</h3>
|
||||
|
||||
<div align="center">
|
||||
</div>
|
||||
|
||||
[](http://hackathon.url.com)
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
<p align="center">Несколько строк, описывающих ваш проект.<br></p>
|
||||
|
||||
## 📝 Содержание
|
||||
|
||||
- [Постановка задачи](#problem_statement)
|
||||
- [Идея/Решение](#idea)
|
||||
- [Зависимости/Ограничения](#limitations)
|
||||
- [Планы на будущее](#future_scope)
|
||||
- [Настройка локальной среды](#getting_started)
|
||||
- [Применение](#usage)
|
||||
- [Стек технологий](#tech_stack)
|
||||
- [Участие](../CONTRIBUTING.md)
|
||||
- [Авторы](#authors)
|
||||
- [Благодарности](#acknowledgments)
|
||||
|
||||
## 🧐 Постановка задачи<a name="problem_statement"></a>
|
||||
|
||||
При написании постановки задачи полезно разработать и придерживаться определенного формата. Хотя для этого есть несколько вариантов, ниже представлен простой и понятный шаблон, который часто используется в бизнес-аналитике, чтобы сосредоточиться на определении проблемы.
|
||||
|
||||
- ИДЕАЛЬНО: Этот раздел используется для описания желаемого или «будущего» состояния процесса или продукта. В целом этот раздел должен проиллюстрировать, как будет выглядеть ожидаемая среда после реализации решения.
|
||||
- РЕАЛЬНОСТЬ: Этот раздел используется для описания текущего или «как есть» состояния процесса или продукта.
|
||||
- ПОСЛЕДСТВИЯ. Этот раздел используется для описания воздействия на бизнес, если проблема не будет устранена или улучшена. Сюда входят затраты, связанные с потерей денег, времени, производительности, конкурентного преимущества и т.д.
|
||||
|
||||
Следование этому формату приведет к созданию работоспособного документа, который можно использовать для понимания проблемы и выявления требований, которые приведут к выигрышному решению.
|
||||
|
||||
## 💡 Идея / Решение<a name="idea"></a>
|
||||
|
||||
Этот раздел используется для описания возможных решений.
|
||||
|
||||
После того, как разделы об идеале, реальности и последствиях завершены и поняты, становится проще найти решение проблемы.
|
||||
|
||||
## ⛓️ Зависимости / ограничения<a name="limitations"></a>
|
||||
|
||||
- Каковы зависимости вашего проекта?
|
||||
- Опишите каждое ограничение подробно, но кратко
|
||||
- Объясните, почему существует каждое ограничение
|
||||
- Укажите причины, по которым каждое ограничение не может быть преодолено с помощью метода(ов), выбранного для приобретения
|
||||
- Оцените влияние каждого ограничения на общие результаты и выводы вашего проекта и, если это уместно, опишите, как эти ограничения могут указывать на необходимость дальнейших исследований.
|
||||
|
||||
## 🚀 <a name="future_scope">Планы на будущее</a>
|
||||
|
||||
Напишите о том, чего вы не смогли разработать в ходе Хакатона; и о том, чего может достичь ваш проект в будущем.
|
||||
|
||||
## 🏁 Начало работы<a name="getting_started"></a>
|
||||
|
||||
Эти инструкции позволят вам запустить копию проекта на локальном компьютере в целях разработки и тестирования. К ак развернуть проект в действующей системе описано в разделе [Развертывание](#deployment).
|
||||
|
||||
### Предпосылки
|
||||
|
||||
Что нужно для установки программного обеспечения и как их установить.
|
||||
|
||||
```
|
||||
Give examples
|
||||
```
|
||||
|
||||
### Установка
|
||||
|
||||
Пошаговая серия примеров, рассказывающих, как запустить среду разработки.
|
||||
|
||||
Скажите, какой будет шаг
|
||||
|
||||
```
|
||||
Give the example
|
||||
```
|
||||
|
||||
И повторить
|
||||
|
||||
```
|
||||
until finished
|
||||
```
|
||||
|
||||
## 🎈 Использование<a name="usage"></a>
|
||||
|
||||
Добавьте примечания о том, как использовать систему.
|
||||
|
||||
## ⛏️ <a name="tech_stack">Стек технологий</a>
|
||||
|
||||
- [MongoDB](https://www.mongodb.com/) — База данных
|
||||
- [Express](https://expressjs.com/) — Серверная структура
|
||||
- [VueJs](https://vuejs.org/) — Веб-фреймворк
|
||||
- [NodeJs](https://nodejs.org/en/) — Серверная среда
|
||||
|
||||
## ✍️ Авторы<a name="authors"></a>
|
||||
|
||||
- [@kylelobo](https://github.com/kylelobo) — Идея и начальная работа
|
||||
|
||||
Список [участников](https://github.com/kylelobo/The-Documentation-Compendium/contributors), работавших в этом проекте.
|
||||
|
||||
## 🎉 Благодарности<a name="acknowledgments"></a>
|
||||
|
||||
- Спасибо всем, чей код использовался
|
||||
- Вдохновение
|
||||
- Ссылки
|
||||
|
@@ -0,0 +1,46 @@
|
||||
# Название Проекта
|
||||
|
||||
## Оглавление
|
||||
|
||||
- [О проекте](#about)
|
||||
- [Начало работы](#getting_started)
|
||||
- [Применение](#usage)
|
||||
- [Участие](../CONTRIBUTING.md)
|
||||
|
||||
## <a name="about">О проекте</a>
|
||||
|
||||
Напишите примерно 1-2 абзаца, описывающих цель вашего проекта.
|
||||
|
||||
## <a name="getting_started">Начало работы</a>
|
||||
|
||||
Эти инструкции позволят вам запустить копию проекта на локальном компьютере в целях разработки и тестирования. Как развернуть проект в действующей системе описано в разделе [Развертывание](#deployment).
|
||||
|
||||
### Предпосылки
|
||||
|
||||
Что нужно для установки программного обеспечения и как его установить.
|
||||
|
||||
```
|
||||
Give examples
|
||||
```
|
||||
|
||||
### Установка
|
||||
|
||||
Пошаговая серия примеров, рассказывающих, как запустить среду разработки.
|
||||
|
||||
Скажите, какой будет шаг
|
||||
|
||||
```
|
||||
Give the example
|
||||
```
|
||||
|
||||
И повторите
|
||||
|
||||
```
|
||||
until finished
|
||||
```
|
||||
|
||||
Закончите примером получения некоторых данных из системы и использования их для небольшой демонстрации.
|
||||
|
||||
## Применение<a name="usage"></a>
|
||||
|
||||
Добавьте примечания о том, как использовать систему.
|
||||
|
@@ -0,0 +1,108 @@
|
||||
<p align="center"><a href="" rel="noopener"> </a><img width="200px" height="200px" src="https://i.imgur.com/6wj0hh6.jpg" alt="Логотип проекта"></p>
|
||||
|
||||
<h3 align="center">Название Проекта</h3>
|
||||
|
||||
<div align="center">
|
||||
</div>
|
||||
|
||||
[]()
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
<p align="center">Несколько строк, описывающих ваш проект.<br></p>
|
||||
|
||||
## 📝 Содержание
|
||||
|
||||
- [О проекте](#about)
|
||||
- [Начало работы](#getting_started)
|
||||
- [Развертывание](#deployment)
|
||||
- [Применение](#usage)
|
||||
- [Построен с использованием](#built_using)
|
||||
- [To Do](../TODO.md)
|
||||
- [Участие](../CONTRIBUTING.md)
|
||||
- [Авторы](#authors)
|
||||
- [Благодарности](#acknowledgement)
|
||||
|
||||
## 🧐 <a name="about">о проекте</a>
|
||||
|
||||
Напишите примерно 1-2 абзаца, описывающих цель вашего проекта.
|
||||
|
||||
## 🏁 Начало работы<a name="getting_started"></a>
|
||||
|
||||
Эти инструкции позволят вам запустить копию проекта на локальном компьютере в целях разработки и тестирования. К ак развернуть проект в действующей системе описано в разделе [Развертывание](#deployment).
|
||||
|
||||
### Предпосылки
|
||||
|
||||
Что нужно для установки программного обеспечения и как их установить.
|
||||
|
||||
```
|
||||
Give examples
|
||||
```
|
||||
|
||||
### Установка
|
||||
|
||||
Пошаговая серия примеров, рассказывающих, как запустить среду разработки.
|
||||
|
||||
Скажите, какой будет шаг
|
||||
|
||||
```
|
||||
Give the example
|
||||
```
|
||||
|
||||
И повторите
|
||||
|
||||
```
|
||||
until finished
|
||||
```
|
||||
|
||||
Закончите примером получения некоторых данных из системы или использования их для небольшой демонстрации.
|
||||
|
||||
## 🔧 Запуск тестов<a name="tests"></a>
|
||||
|
||||
Объясните, как запустить автоматические тесты для этой системы.
|
||||
|
||||
### Разбейте на сквозные тесты
|
||||
|
||||
Объясните, что проверяют эти тесты и почему
|
||||
|
||||
```
|
||||
Give an example
|
||||
```
|
||||
|
||||
### И тесты стиля кода
|
||||
|
||||
Объясните, что проверяют эти тесты и почему
|
||||
|
||||
```
|
||||
Give an example
|
||||
```
|
||||
|
||||
## 🎈 Использование<a name="usage"></a>
|
||||
|
||||
Добавьте примечания о том, как использовать систему.
|
||||
|
||||
## 🚀 Развертывание<a name="deployment"></a>
|
||||
|
||||
Добавьте дополнительные примечания о том, как развернуть это в действующей системе.
|
||||
|
||||
## ⛏️ Построен с использованием<a name="built_using"></a>
|
||||
|
||||
- [MongoDB](https://www.mongodb.com/) — База данных
|
||||
- [Express](https://expressjs.com/) — Серверная структура
|
||||
- [VueJs](https://vuejs.org/) — Веб-фреймворк
|
||||
- [NodeJs](https://nodejs.org/en/) — Серверная среда
|
||||
|
||||
## ✍️ Авторы<a name="authors"></a>
|
||||
|
||||
- [@kylelobo](https://github.com/kylelobo) — Идея и начальная работа
|
||||
|
||||
Список [участников](https://github.com/kylelobo/The-Documentation-Compendium/contributors), работавших в этом проекте.
|
||||
|
||||
## 🎉 Благодарности<a name="acknowledgement"></a>
|
||||
|
||||
- Спасибо всем, чей код использовался
|
||||
- Вдохновение
|
||||
- Ссылки
|
||||
|
@@ -1,6 +1,9 @@
|
||||
### TODO
|
||||
### <a>To Do</a>
|
||||
|
||||
---
|
||||
|
||||
- [ ] переводить шаблоны
|
||||
|
||||
- [x] Создать README.md файл в папке [README_TEMPLATES](./README_TEMPLATES).
|
||||
- [ ] Создать шаблон IoT (за помощью обратитесь к документации по различным проектам Arduino). Этот шаблон должен быть подробным и должен углубляться в различные аппаратные термины.
|
||||
- [ ] Сделайте минимальный шаблон IoT.
|
||||
- [ ] Добавить файл COMMIT_MESSAGE_GUIDELINES.md.
|
||||
- [ ] Перевести [шаблоны](https://github.com/kylelobo/The-Documentation-Compendium#templates) на разные языки — китайский, французский, немецкий, хинди, итальянский, японский, корейский, португальский, русский, испанский и т. д.
|
||||
|
Reference in New Issue
Block a user