Рекомендации по разработке документации

Ограничения по терминам

Не использовать

Ограничения синтаксиса `markdown` для `DocFX`

Не использовать прописные буквы (UPCASE) в именах ссылок на файлы ресурсов.
В именах ссылок использовать пробелы заменять на - или %20
В документе не использовать более одного заголовка первого уровня.
Перекрестные ссылки:
1. Для важных тем используйте уникальный идентификатор (UID) для доступа вместо пути к файлу. Пример ссылки через UID Модель интеграции

---
uid: uid_of_the_topic
---

Markdown link: [link_text](xref:uid_of_the_topic)
Auto link: <xref:uid_of_the_topic>
Shorthand form: @"uid_of_the_topic"

2. Описывайте `якоря` - идентификаторы для ссылок внутри документов.

## <a id="esb" />ESB

Идентификатор ссылки на раздел документа [ESB](#esb).

Включение файла

{ // Все провайдеры, Loglevel применяется ко всем поставщикам, которые поддерживают это свойство "Logging": { "LogLevel": { // Журнал по умолчанию, Error и выше "Default": "Error", // Все категории Microsoft *, Warning и выше. "Microsoft": "Warning" }, // Debug провайдер. "Debug": { "LogLevel": { // Переопределение предыдущих настроек LogLevel:Default. "Default": "Information", // Категория для Debug:Microsoft.Hosting. "Microsoft.Hosting": "Trace" } }, // EventSource провайдер "EventSource": { "LogLevel": { // Все категории EventSource провайдера. "Default": "Warning" } } } }

Включение кода

Code Snippet Sample
[!code-csharp[Main](Program.cs)]

[!code[Main](Program.cs#L12-L16 "This is source file")]
[!code-vb[Main](../Application/Program.vb#testsnippet "This is source file")]

[!code[Main](index.xml?start=5&end=9)]
[!code-javascript[Main](../jquery.js?name=testsnippet)]
[!code[Main](index.xml?range=2,5-7,9-) "This includes the lines 2, 5, 6, 7 and lines 9 to the last line"]
[!code[Main](index.xml?highlight=2,5-7,9-) "This includes the whole file with lines 2,5-7,9- highlighted"]

{
    // Все провайдеры, Loglevel применяется ко всем поставщикам, которые поддерживают это свойство
    "Logging": {
        "LogLevel": {
            // Журнал по умолчанию, Error и выше
            "Default": "Error",
            // Все категории Microsoft *, Warning и выше.
            "Microsoft": "Warning"
        },
        // Debug провайдер.
        "Debug": {
            "LogLevel": {
                // Переопределение предыдущих настроек LogLevel:Default.
                "Default": "Information",
                // Категория для Debug:Microsoft.Hosting.
                "Microsoft.Hosting": "Trace"
            }
        },
        // EventSource провайдер
        "EventSource": {
            "LogLevel": {
                // Все категории EventSource провайдера.
                "Default": "Warning"
            }
        }
    }
}

"LogLevel": {
    // Журнал по умолчанию, Error и выше
    "Default": "Error",
    // Все категории Microsoft *, Warning и выше.
    "Microsoft": "Warning"

Навигация по меню приложения

Нажмите кнопку Run.
В меню выберите Настройки интеграции > Пользовательская модель.
Нажмите ENTER.

Highlight

I need to highlight these ==very important words==. I need to highlight these very important words.

Footnotes

Here's a simple footnote,[^1] and here's a longer one.[^bignote]

[^1]: This is the first footnote. [^bignote]: Here's one with multiple paragraphs and code. Indent paragraphs to include them in the footnote.

`{ my code }`

Add as many paragraphs as you like.

Сноски

...инструментами бизнес-аналитики¹, чтобы они могли принимать обоснованные бизнес-решения².

1 Buisness Intelligence. ² бизнес-решения....

AdventureWorks sample databases

Смотри также:

Рекомендации по разработке документации

Ограничения по терминам