Co-authored-by: ArtemFilin1990 <221041513+ArtemFilin1990@users.noreply.github.com>
15 KiB
Руководство по созданию статей для технического справочника
Назначение
Это руководство объясняет, как использовать промт PROMPT_ARTICLE_CREATION.md для создания высококачественных, самостоятельных статей по подшипникам и сопутствующим изделиям.
Быстрый старт
1. Выберите тему из оглавления
Откройте главное README и выберите раздел, для которого нужно создать статью. Например:
1.1. Что такое подшипник? Основные функции5.3. Роликовые цилиндрические8.2. ISO (международные стандарты)
2. Определите тип статьи
Определите, к какой части относится ваша тема:
| Часть | Тип статьи | Фокус |
|---|---|---|
| Часть I | Теоретическая | Понимание принципов и фундаментальных концепций |
| Часть II | Справочная (Типы) | Технические характеристики и области применения |
| Часть III | Справочная (Стандарты) | Нормативная база и системы обозначений |
| Часть IV | Справочная (Сопутствующие) | Алгоритмы подбора и практические инструкции |
3. Используйте промт
Откройте PROMPT_ARTICLE_CREATION.md и следуйте инструкциям для соответствующего типа статьи.
Пример запроса к AI:
Используя промт из файла PROMPT_ARTICLE_CREATION.md, создайте статью для подраздела:
"1.1. Что такое подшипник? Основные функции"
Это теоретическая статья из Части I, поэтому следуйте соответствующим требованиям:
- Включите полное определение
- Добавьте историческую справку
- Объясните физические принципы
- Приведите практические примеры
- Создайте минимум 2 таблицы
- Обеспечьте объем 2000-3000 слов
4. Сохраните файл
Создайте файл в соответствующей директории с правильным именем:
Структура директорий:
part-i/ - Часть I: Основы и теория
part-ii/ - Часть II: Типы и модификации
part-iii/ - Часть III: Стандарты и производители
part-iv/ - Часть IV: Сопутствующие изделия
Формат имени файла:
[номер]-[краткое-название-латиницей].md
Примеры:
part-i/1-1-chto-takoe-podshipnik.mdpart-ii/5-3-rolikovye-tsilindricheskie.mdpart-iii/8-2-iso-standarty.md
Подробная инструкция
Шаг 1: Подготовка
- Изучите существующие статьи в соответствующей части справочника
- Соберите источники: ГОСТ, ISO, каталоги производителей
- Определите ключевые термины для вашей темы
Шаг 2: Структура статьи
Каждая статья должна следовать единой структуре:
# [Номер и название]
*Метаданные*
## Содержание
[Оглавление статьи]
## [Основные разделы]
[Контент с таблицами и примерами]
## Ключевые выводы
[3-4 основных тезиса]
## Связанные материалы
[Навигационные ссылки]
Шаг 3: Контент
Для теоретических статей (Часть I):
Обязательно включите:
- ✅ Техническое определение
- ✅ Историческую справку
- ✅ Физические принципы
- ✅ Формулы (если применимо)
- ✅ Сравнительные таблицы
- ✅ Практические примеры
Объем: 2000-3000 слов
Для справочных статей (Части II-IV):
Обязательно включите:
- ✅ Классификацию
- ✅ Технические характеристики
- ✅ Примеры маркировки
- ✅ Алгоритмы подбора
- ✅ Таблицы аналогов
- ✅ Инструкции по применению
Объем: 1500-2500 слов
Шаг 4: Таблицы
Каждая статья должна содержать минимум 2 таблицы:
Типы таблиц:
- Сравнительная таблица - сравнение характеристик
- Справочная таблица - размеры, аналоги, технические данные
- Таблица соответствий - ГОСТ ↔ ISO, аналоги брендов
- Классификационная таблица - типы и категории
Формат:
| Параметр | Значение 1 | Значение 2 | Примечание |
|----------|------------|------------|------------|
| ... | ... | ... | ... |
Шаг 5: Примеры
Включите практические примеры:
-
Пример расчета (для теоретических статей)
### Пример расчета срока службы **Исходные данные:** - Радиальная нагрузка: Fr = 1000 Н - Динамическая грузоподъемность: C = 14000 Н - Частота вращения: n = 1500 об/мин **Расчет:** L₁₀ = (C/P)³ × 10⁶ оборотов ... -
Пример маркировки (для справочных статей)
### Пример расшифровки: 6205-2RS **Пошаговая расшифровка:** 1. **6** — тип подшипника 2. **2** — серия диаметров 3. **05** — внутренний диаметр 4. **2RS** — уплотнения **Источник:** ГОСТ 3478-2012 -
Пример подбора (для практических статей)
### Пример подбора для электродвигателя **Условия эксплуатации:** - Мощность двигателя: 5 кВт - Частота вращения: 3000 об/мин - Температура: до +80°C **Решение:** Рекомендуется подшипник типа 6206-2RS...
Шаг 6: Визуальные элементы
Укажите места для необходимых изображений:
[Схема: Конструкция шарикового подшипника]
[График: Зависимость нагрузки от срока службы]
[Фото: Подшипник 6205-2RS]
[Диаграмма: Классификация по типам]
Примечание: Изображения должны быть размещены в директории Изображения/ с понятными именами.
Шаг 7: Ключевые выводы
Сформулируйте 3-4 основных тезиса:
## Ключевые выводы
1. **Основной тезис** - краткая формулировка главной идеи статьи
2. **Практическое применение** - где и как используется
3. **Критические характеристики** - на что обратить внимание
4. **Рекомендации** - практические советы по выбору/применению
Шаг 8: Навигация
Добавьте ссылки на связанные материалы:
## Связанные материалы
### Внутренние ссылки
- [← Предыдущая статья: ...](...)
- [Следующая статья: ... →](...)
- [↑ Оглавление раздела](../README.md)
### Дополнительные ресурсы
- [Смежная тема: ...](...)
- [Практическое руководство: ...](...)
Проверочный чек-лист
Перед публикацией статьи проверьте:
Структура и форматирование
- Заголовок соответствует номеру и названию раздела
- Есть дата обновления и ключевые слова
- Оглавление статьи с рабочими якорями
- Все таблицы правильно отформатированы
- Корректный Markdown синтаксис
Контент
- Объем статьи соответствует требованиям (мин. 1500 слов)
- Минимум 2 таблицы с полезными данными
- Есть практические примеры (расчет/маркировка/подбор)
- Указаны источники информации (ГОСТ, ISO, каталоги)
- Нет противоречий с другими статьями
Обязательные разделы
- Раздел "Ключевые выводы" (3-4 пункта)
- Раздел "Связанные материалы" с ссылками
- Навигация: предыдущая/следующая статья
- Ссылка на оглавление раздела
Качество
- Технически точная информация
- Понятный стиль изложения
- Практическая ценность для читателя
- Указания на необходимые изображения
- Все внутренние ссылки работают
Примеры готовых статей
Для вдохновения изучите существующие статьи:
Теоретические (Часть I):
Справочные (Части II-IV):
Часто задаваемые вопросы
Какой объем должна иметь статья?
Минимум: 1500 слов Оптимально: 2000-3000 слов для теоретических, 1500-2500 для справочных Максимум: 5000 слов (только для очень сложных тем)
Сколько таблиц нужно включить?
Минимум: 2 таблицы
- 1 сравнительная или классификационная
- 1 справочная с техническими данными
Рекомендуется: 3-4 таблицы для полноты раскрытия темы
Нужно ли указывать источники?
Обязательно! Каждое техническое утверждение должно иметь ссылку на:
- ГОСТ (номер, год)
- ISO (номер)
- Каталог производителя (бренд, год издания)
- Техническую литературу (полные библиографические данные)
Как назвать файл статьи?
Формат: [номер]-[название-латиницей].md
Правила транслитерации:
ч→chш→shщ→shchю→yuя→ya- Пробелы → дефисы
-
Примеры:
- "Что такое подшипник" →
chto-takoe-podshipnik.md - "Сальники и манжеты" →
salniki-i-manzhety.md
Где хранить изображения?
Все изображения должны быть размещены в директории Изображения/ в корне репозитория.
Формат имени изображения:
[номер-раздела]-[описание].[расширение]
Примеры:
1-1-konstruktsiya-podshipnika.png5-3-rolikovyj-tsilindricheskij.jpg
Дополнительные ресурсы
Документация
- Главный промт - полное руководство по созданию статей
- Шаблон статьи - базовая структура
- Правила участия - общие требования к контенту
- Навигация по репозиторию - структура и организация
Стандарты
- ГОСТ 3478-2012 - Подшипники качения. Обозначения
- ISO 15 - Rolling bearings - Radial bearings
- Таблицы аналогов - Соответствия ГОСТ ↔ ISO
Примеры
- Учебник-справочник - полная версия
- Практические руководства - примеры статей
- Академический учебник - модульная структура
Поддержка
Если у вас возникли вопросы по созданию статей:
- Изучите промт и это руководство
- Посмотрите примеры существующих статей
- Проверьте проверочный чек-лист
- Создайте Issue в репозитории с вопросом
Последнее обновление: 2026-01-10