You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ydb/docs/en/core/contributor/documentation/genres.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
##{{ ydb-short-name }} documentation genres
1
+
# {{ ydb-short-name }} documentation genres
2
2
3
3
This article complements [{#T}](style-guide.md) by describing the main genres used in {{ ydb-short-name }} documentation. Understanding these genres helps contributors place new content in the appropriate section and maintain a consistent structure.
4
4
5
-
###Theory {#theory}
5
+
## Theory {#theory}
6
6
7
7
**Primary goal for the reader:** build a solid knowledge foundation by understanding the fundamental concepts, architecture, and principles behind {{ ydb-short-name }}.
8
8
@@ -15,7 +15,7 @@ This article complements [{#T}](style-guide.md) by describing the main genres us
15
15
16
16
Theory documentation is primarily found in the ["Concepts"](../../concepts/index.md) section but also appears in role-specific folders when the theoretical information is relevant only to a particular audience.
17
17
18
-
###Guide {#guide}
18
+
## Guide {#guide}
19
19
20
20
**Primary goal for the reader:** accomplish a specific practical task or implement a particular solution with {{ ydb-short-name }} by following instructions.
21
21
@@ -29,7 +29,7 @@ Guides are practical, step-by-step instructions that help users accomplish a spe
29
29
30
30
Guides are primarily found in role-specific folders like ["For DevOps"](../../devops/index.md), ["For Developers"](../../dev/index.md), and ["For Security Engineers"](../../security/index.md), as well as in the ["Troubleshooting"](../../troubleshooting/index.md) section.
31
31
32
-
###Reference {#reference}
32
+
## Reference {#reference}
33
33
34
34
**Primary goal for the reader:** find additional information about a specific niche topic related to {{ ydb-short-name }}.
35
35
@@ -43,7 +43,7 @@ Reference documentation provides comprehensive, detailed information about {{ yd
43
43
44
44
Reference documentation is designed to be found as needed and is the most detailed level of documentation. It's particularly useful when users need specific information about functions, settings, or keywords. This content is primarily found in the ["Reference"](../../reference/index.md) section.
45
45
46
-
###FAQ {#faq}
46
+
## FAQ {#faq}
47
47
48
48
**Primary goal for the reader:** quickly find answers to common questions encountered when working with {{ ydb-short-name }}.
49
49
@@ -57,7 +57,7 @@ Frequently Asked Questions (FAQ) documentation answers common questions about {{
57
57
58
58
FAQ content is primarily found in the ["Questions and answers"](../../faq/index.md) section and is designed to help users who are searching for specific solutions to common situations.
59
59
60
-
###Recipe {#recipe}
60
+
## Recipe {#recipe}
61
61
62
62
**Primary goal for the reader:** implement a specific, focused solution to a common issue or use case with {{ ydb-short-name }}.
63
63
@@ -71,7 +71,7 @@ Recipes are short, focused mini-guides that demonstrate how to accomplish specif
71
71
72
72
Recipes are primarily found in the ["Recipes"](../../recipes/index.md) section, though similar content may also appear in role-specific folders.
73
73
74
-
###Release notes {#release-notes}
74
+
## Release notes {#release-notes}
75
75
76
76
**Primary goal for the reader:** stay informed about new features, improvements, bug fixes, and breaking changes in {{ ydb-short-name }} releases.
77
77
@@ -85,7 +85,7 @@ Release notes document changes, improvements, and fixes in each new version of {
85
85
86
86
Release notes are found in the ["Changelog"](../../changelog-server.md) section and help users understand what has changed between versions and decide whether to upgrade.
87
87
88
-
###Collection of links {#links}
88
+
## Collection of links {#links}
89
89
90
90
**Primary goal for the reader:** discover additional resources, learning materials, and external content related to {{ ydb-short-name }}.
Copy file name to clipboardExpand all lines: ydb/docs/en/core/contributor/documentation/structure.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
##{{ ydb-short-name }} documentation structure
1
+
# {{ ydb-short-name }} documentation structure
2
2
3
3
This article complements [{#T}](style-guide.md). It explains the current top-level folders of the documentation and what kind of content belongs in each. As a rule of thumb, most top-level sections focus either on a specific target audience (if named "For ...") or on a specific [genre](genres.md).
Copy file name to clipboardExpand all lines: ydb/docs/ru/core/contributor/documentation/genres.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
##Жанры документации {{ ydb-short-name }}
1
+
# Жанры документации {{ ydb-short-name }}
2
2
3
3
Эта статья дополняет [{#T}](style-guide.md), описывая основные жанры статей, используемые в документации {{ ydb-short-name }}. Понимание этих жанров помогает контрибьюторам размещать новый контент в соответствующем разделе и поддерживать консистентную структуру материалов.
4
4
5
-
###Теория {#theory}
5
+
## Теория {#theory}
6
6
7
7
**Основная цель для читателя:** построить прочный фундамент знаний и прийти к пониманию основных концепций, архитектуры и принципов, на которых работает {{ ydb-short-name }}.
8
8
@@ -17,7 +17,7 @@
17
17
18
18
Теоретическая документация в основном находится в разделе [{#T}](../../concepts/index.md), но также появляется и в папках, специфичных для ролей, когда теоретическая информация релевантна только для конкретной аудитории.
19
19
20
-
###Руководство {#guide}
20
+
## Руководство {#guide}
21
21
22
22
**Основная цель для читателя:** выполнить конкретную практическую задачу или реализовать определённое решение с помощью {{ ydb-short-name }}, следуя инструкциям.
23
23
@@ -31,7 +31,7 @@
31
31
32
32
Руководства в основном находятся в папках, специфичных для ролей, таких как [{#T}](../../devops/index.md), [{#T}](../../dev/index.md) и [{#T}](../../security/index.md), а также в разделе [{#T}](../../troubleshooting/index.md).
33
33
34
-
###Справочник {#reference}
34
+
## Справочник {#reference}
35
35
36
36
**Основная цель для читателя:** найти дополнительную информацию по конкретной узкой теме, связанной с {{ ydb-short-name }}.
37
37
@@ -45,7 +45,7 @@
45
45
46
46
Справочная документация разработана для поиска по мере необходимости и является самым подробным уровнем документации. Она особенно полезна, когда пользователям нужна конкретная информация о функциях, настройках или ключевых словах. Этот контент в основном находится в разделе [{#T}](../../reference/index.md).
47
47
48
-
###FAQ {#faq}
48
+
## FAQ {#faq}
49
49
50
50
**Основная цель для читателя:** быстро найти ответы на распространённые вопросы, возникающие при работе с {{ ydb-short-name }}.
51
51
@@ -59,7 +59,7 @@
59
59
60
60
Контент FAQ в основном находится в разделе [{#T}](../../faq/index.md) и разработан для помощи пользователям, которые ищут конкретные решения для типовых ситуаций.
61
61
62
-
###Рецепт {#recipe}
62
+
## Рецепт {#recipe}
63
63
64
64
**Основная цель для читателя:** реализовать конкретное, сфокусированное решение для типовой проблемы или сценария использования с помощью {{ ydb-short-name }}.
65
65
@@ -73,7 +73,7 @@
73
73
74
74
Рецепты в основном находятся в разделе [{#T}](../../recipes/index.md), хотя похожий контент может также появляться в папках, специфичных для роли.
75
75
76
-
###Заметки о выпуске {#release-notes}
76
+
## Заметки о выпуске {#release-notes}
77
77
78
78
**Основная цель для читателя:** быть в курсе новых функций, улучшений, исправлений ошибок и критических изменений в выпусках {{ ydb-short-name }}.
79
79
@@ -87,7 +87,7 @@
87
87
88
88
Заметки о выпуске находятся в разделе [{#T}](../../changelog-server.md) и помогают пользователям понять, что изменилось между версиями, и решить, обновляться ли.
89
89
90
-
###Коллекция ссылок {#links}
90
+
## Коллекция ссылок {#links}
91
91
92
92
**Основная цель для читателя:** открыть для себя дополнительные ресурсы, учебные материалы и внешний контент, связанный с {{ ydb-short-name }}.
Copy file name to clipboardExpand all lines: ydb/docs/ru/core/contributor/documentation/structure.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
##Структура документации {{ ydb-short-name }}
1
+
# Структура документации {{ ydb-short-name }}
2
2
3
3
Эта статья дополняет [{#T}](style-guide.md). Она объясняет текущие директории верхнего уровня документации и какой контент принадлежит каждой из них. Как правило, большинство разделов верхнего уровня фокусируются либо на конкретной целевой аудитории (если названы «Для ...»), либо на конкретном [жанре](genres.md).
0 commit comments