docs: убрать «воду» из вводных абзацев разделов
- удалены обороты «Раздел описывает», «Этот раздел описывает» из 10 файлов docs/ru - вводные абзацы переписаны в формате «тема: категории/области» без перечисления конкретного содержимого раздела - удалён frontmatter description из basics/architecture/index.md (подтягивается первый абзац после h1 — про SLM Design) - в CONTRIBUTING.md добавлен раздел «Вводный абзац» с правилами и блоками «Хорошо/Плохо»: что делать, чего избегать, проверка на излишнюю конкретику
This commit is contained in:
@@ -185,6 +185,50 @@ title: Название раздела
|
|||||||
- Подсекции внутри `h2` — `h3`.
|
- Подсекции внутри `h2` — `h3`.
|
||||||
- `h4` не используется.
|
- `h4` не используется.
|
||||||
|
|
||||||
|
### Вводный абзац
|
||||||
|
|
||||||
|
Абзац сразу после `h1` отвечает на вопрос «о чём этот раздел?».
|
||||||
|
Он попадает в `llms.txt` и `README.md` архива как краткое описание,
|
||||||
|
поэтому должен быть плотным и без воды.
|
||||||
|
|
||||||
|
**Правила:**
|
||||||
|
|
||||||
|
- Не начинать с «Раздел описывает», «Этот раздел», «В этом разделе»,
|
||||||
|
«Здесь рассмотрено», «В этом документе».
|
||||||
|
- Начинать с подлежащего — самой темы (`Слои SLM:`, `Соглашения об именовании:`).
|
||||||
|
- Двоеточие или тире для перечисления **категорий и областей**, а не
|
||||||
|
конкретных значений из содержимого.
|
||||||
|
- Не дублировать содержимое: если внутри раздела 12 правил —
|
||||||
|
не перечислять их во вводном абзаце.
|
||||||
|
- Не аргументировать («единые правила делают код предсказуемым»).
|
||||||
|
- 1–2 предложения.
|
||||||
|
|
||||||
|
**Проверка:** если при добавлении нового правила/инструмента/раздела
|
||||||
|
вводный абзац придётся править — он слишком конкретный.
|
||||||
|
|
||||||
|
**Хорошо:**
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
Слои SLM: назначение, классификация, направление зависимостей, правила.
|
||||||
|
```
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
Базовый стек проекта по областям: UI, архитектура, данные, состояние,
|
||||||
|
локализация, тестирование, стили, генерация кода.
|
||||||
|
```
|
||||||
|
|
||||||
|
**Плохо:**
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
Раздел описывает слои SLM: что такое слой, какие бывают, как между
|
||||||
|
ними направлены зависимости и какие правила действуют на каждом.
|
||||||
|
```
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
Этот раздел описывает базовый стек технологий и библиотек, принятый в
|
||||||
|
проекте. React, TypeScript, Next.js, SWR, Zustand, i18next.
|
||||||
|
```
|
||||||
|
|
||||||
### Примеры кода
|
### Примеры кода
|
||||||
|
|
||||||
- Блоки кода с указанием языка: ` ```tsx `, ` ```css `, ` ```bash `, ` ```text `.
|
- Блоки кода с указанием языка: ` ```tsx `, ` ```css `, ` ```bash `, ` ```text `.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# NextJS Style Guide
|
# NextJS Style Guide
|
||||||
|
|
||||||
Rules and standards for NextJS and TypeScript development: architecture, typing, styles, components, API, and infrastructure.
|
Conventions for Next.js project development: application architecture and layers, code structure, module organization, styling, typing, and infrastructure.
|
||||||
|
|
||||||
## Documentation Structure
|
## Documentation Structure
|
||||||
|
|
||||||
@@ -26,7 +26,7 @@ Rules and standards for NextJS and TypeScript development: architecture, typing,
|
|||||||
| Section | Answers the question |
|
| Section | Answers the question |
|
||||||
|---------|---------------------|
|
|---------|---------------------|
|
||||||
| Tech Stack | What stack do we use? |
|
| Tech Stack | What stack do we use? |
|
||||||
| Architecture | How are FSD layers, dependencies, and public API structured? |
|
| Architecture | How are SLM layers, dependencies, and public API structured? |
|
||||||
| Code Style | How to format code: indentation, quotes, imports, early return? |
|
| Code Style | How to format code: indentation, quotes, imports, early return? |
|
||||||
| Naming | How to name files, variables, components, hooks? |
|
| Naming | How to name files, variables, components, hooks? |
|
||||||
| Documentation | How to write JSDoc: what to document and what not? |
|
| Documentation | How to write JSDoc: what to document and what not? |
|
||||||
@@ -51,8 +51,3 @@ Rules and standards for NextJS and TypeScript development: architecture, typing,
|
|||||||
| Hooks | _(not filled)_ |
|
| Hooks | _(not filled)_ |
|
||||||
| Fonts | _(not filled)_ |
|
| Fonts | _(not filled)_ |
|
||||||
| Localization | _(not filled)_ |
|
| Localization | _(not filled)_ |
|
||||||
|
|
||||||
## For Assistants
|
|
||||||
|
|
||||||
Documentation map with links to all sections ([llmstxt.org](https://llmstxt.org) format):
|
|
||||||
https://gromlab.ru/docs/nextjs-style-guide/raw/branch/main/generated/en/llms.txt
|
|
||||||
|
|||||||
@@ -1,11 +1,6 @@
|
|||||||
# NextJS Style Guide
|
# NextJS Style Guide
|
||||||
|
|
||||||
Правила и стандарты разработки на NextJS и TypeScript: архитектура, типизация, стили, компоненты, API и инфраструктурные разделы.
|
Соглашения по разработке Next.js проектов: архитектура и слои приложения, структура кода, организация модулей, стилизация, типизация и инфраструктура.
|
||||||
|
|
||||||
## Для ассистентов
|
|
||||||
|
|
||||||
Карта документации со ссылками на все разделы (формат [llmstxt.org](https://llmstxt.org)):
|
|
||||||
https://gromlab.ru/docs/nextjs-style-guide/raw/branch/main/generated/ru/llms.txt
|
|
||||||
|
|
||||||
## Структура документации
|
## Структура документации
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ title: Структура проекта
|
|||||||
|
|
||||||
# Структура проекта
|
# Структура проекта
|
||||||
|
|
||||||
Раздел описывает расположение файлов и папок в проекте Next.js (App Router).
|
Файловая организация Next.js-проекта по архитектуре SLM.
|
||||||
|
|
||||||
## Корень репозитория
|
## Корень репозитория
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ title: Стили
|
|||||||
|
|
||||||
# Стили
|
# Стили
|
||||||
|
|
||||||
Раздел описывает правила написания CSS: PostCSS Modules, вложенность, медиа-запросы, переменные, форматирование.
|
Правила написания CSS: PostCSS Modules, форматирование, переменные.
|
||||||
|
|
||||||
## Общие правила
|
## Общие правила
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
---
|
---
|
||||||
title: Архитектура
|
title: Архитектура
|
||||||
description: "Раздел описывает архитектуру проекта: из каких слоёв состоит приложение, как организован код внутри слоёв и какие правила управляют зависимостями."
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# SLM Design
|
# SLM Design
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ title: Слои
|
|||||||
|
|
||||||
# Слои
|
# Слои
|
||||||
|
|
||||||
Раздел описывает слои SLM: что такое слой, какие бывают, как между ними направлены зависимости и какие правила действуют на каждом.
|
Слои SLM: назначение, классификация, направление зависимостей, правила.
|
||||||
|
|
||||||
## Определение
|
## Определение
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ title: Модули
|
|||||||
|
|
||||||
# Модули
|
# Модули
|
||||||
|
|
||||||
Раздел описывает модули SLM: что такое модуль, из чего он состоит и как взаимодействует с остальным кодом.
|
Модули SLM: состав, границы, взаимодействие с остальным кодом.
|
||||||
|
|
||||||
## Определение
|
## Определение
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ title: Сегменты
|
|||||||
|
|
||||||
# Сегменты
|
# Сегменты
|
||||||
|
|
||||||
Раздел описывает сегменты SLM: что такое сегмент, какие бывают и что в каждом из них лежит.
|
Сегменты SLM: типы, назначение, что лежит внутри каждого.
|
||||||
|
|
||||||
## Определение
|
## Определение
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ title: Стиль кода
|
|||||||
|
|
||||||
# Стиль кода
|
# Стиль кода
|
||||||
|
|
||||||
Раздел описывает единые правила оформления кода: отступы, переносы, кавычки, порядок импортов и базовую читаемость.
|
Единые правила оформления кода: форматирование, импорты, читаемость.
|
||||||
|
|
||||||
## Отступы
|
## Отступы
|
||||||
|
|
||||||
|
|||||||
@@ -4,8 +4,7 @@ title: Документирование
|
|||||||
|
|
||||||
# Документирование
|
# Документирование
|
||||||
|
|
||||||
Этот раздел описывает правила документирования кода: когда и как писать
|
Правила документирования кода: что и когда документировать через JSDoc.
|
||||||
комментарии к компонентам, функциям, типам и интерфейсам.
|
|
||||||
|
|
||||||
## Общие правила
|
## Общие правила
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ title: Именование
|
|||||||
|
|
||||||
# Именование
|
# Именование
|
||||||
|
|
||||||
Этот раздел описывает соглашения об именовании в проекте. Единые правила делают код предсказуемым и упрощают навигацию по проекту.
|
Соглашения об именовании в коде: что и как называть.
|
||||||
|
|
||||||
## Базовые правила
|
## Базовые правила
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ title: Технологии и библиотеки
|
|||||||
|
|
||||||
# Технологии и библиотеки
|
# Технологии и библиотеки
|
||||||
|
|
||||||
Этот раздел описывает базовый стек технологий и библиотек, принятый в проекте.
|
Базовый стек проекта по областям: UI, архитектура, данные, состояние, локализация, тестирование, стили, генерация кода.
|
||||||
|
|
||||||
## Что используем
|
## Что используем
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ title: Типизация
|
|||||||
|
|
||||||
# Типизация
|
# Типизация
|
||||||
|
|
||||||
Этот раздел описывает правила типизации: как типизировать компоненты, функции и работу с `any`/`unknown`.
|
Правила типизации в TypeScript: общие принципы и работа с динамическими типами.
|
||||||
|
|
||||||
## Общие правила
|
## Общие правила
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user