Поделиться через


Внесите свой вклад в документацию по Dynamics 365

Вы можете внести свой вклад в документацию Майкрософт для Dynamics 365 двумя способами. Если статья содержит неверные или запутанные сведения, или если вы знаете хороший обходной путь для повторяющейся проблемы, вы можете использовать ссылку обратной связи в статье, чтобы сообщить нам об этом.

Для большей части нашей документации вы также можете изменить статью непосредственно для запуска процесса проверки.

Предоставьте отзыв

На веб-сайте learn.microsoft.com каждая статья Learn предлагает возможность предоставить отзывы. Вы можете выбрать действие обратной связи , которое находится в заголовке статьи в правом верхнем углу или один из вариантов обратной связи в нижней части статьи в разделе отзывов . Предоставьте статью рейтингу, выберите причину вашего отзыва и попробуйте оставить комментарий. Отзыв направляется автору статьи и команде, ответственной за документацию.

Если статья не может быть изменена напрямую или если вы не комфортно редактируете, мы рекомендуем использовать механизм обратной связи , чтобы сообщить нам, что вы думаете о статье или продукте.

Внешние вклады в документацию Майкрософт

Исходные файлы для основного содержимого хранятся в общедоступных репозиториях GitHub. Любой пользователь может просмотреть их и, во многих случаях, изменить их. Мы приветствуем ваши рекомендации и исправления, либо в виде прямого вклада, либо через обсуждения GitHub, чтобы сообщить об ошибке или задать вопрос. Мы можем принимать только отзывы и вклады в исходное содержимое на английском языке.

В большинстве статей есть значок карандаша с подсказкой "Изменить этот документ". Выберите значок, чтобы открыть статью в GitHub, а затем начать редактирование. Начните работу в качестве участника, воспользовавшись руководством для участников Microsoft Learn.

Если вы хотите получить подробные сведения и внести свой вклад в новые концептуальные статьи, используйте шаблоны по адресу https://github.com/MicrosoftDocs/dynamics365-docs-templates.

Содержимое руководства Dynamics 365

Содержимое рекомендаций Dynamics 365 использует те же процессы, что и большая часть документации в Microsoft Learn. В этом разделе мы выделяем средства и процессы, которые можно использовать, чтобы помочь дополнить рекомендации по реализации.

Содержание руководства охватывает руководство по реализации Dynamics 365, описания бизнес-процессов, новые шаблоны, лучшие практики и эталонные архитектуры. Мы опубликовали первое содержимое руководства в апреле 2023 года, и мы добавляем обновления каждые две недели. Просмотрите центр рекомендаций и сообщите нам, что здорово и что отсутствует.

Некоторые из рекомендаций предоставляются внутренними участниками. Мы поощряем экспертов по темам во всем сообществе, чтобы они помогли нам в разработке лучших практик. Прочтите дальше, если у вас есть лучшая практика или другие инсайты, которые, по вашему мнению, должны стать частью Microsoft Learn.

Зачем вносить свой вклад?

Мы считаем, что содержимое руководства помогает ускорить выполнение проектов реализации Dynamics 365. Наши партнеры и клиенты могут использовать рекомендации по подготовке к реализации и подготовке к работе в новых областях или подготовке новых сотрудников. Разработчики программного обеспечения могут использовать содержимое в качестве платформы для продвижения своей интеллектуальной собственности или отраслевых знаний.

Но мы в Корпорации Майкрософт не единственные эксперты по реализации решений с помощью Dynamics 365. Сообщество включает людей, которые являются экспертами по различным аспектам реализации. У вас есть шаблон, рекомендация, конфигурация или архитектура интеграции, которая хорошо работает в нескольких реализациях? Рассмотрите возможность совместного использования в Microsoft Learn, чтобы сделать все сообщество еще более продуктивным и эффективным в своих проектах реализации.

Мы надеемся, что мы можем предложить награды или другие подтверждения за вклад. В настоящее время мы признаем участников в статьях двумя различными способами. Дополнительные сведения см. в разделе распознавания участников .

Как внести свой вклад

Исходные файлы для содержимого руководства Microsoft Dynamics 365 можно найти в общедоступном репозитории GitHub. Вы также можете изменить статьи на сайте learn.microsoft.com/dynamics365/guidance , как описано в руководстве участника Microsoft Learn.

Мы рекомендуем отправлять исправления так же, как вы отправляете исправление в другие области Microsoft Learn. Тем не менее, чтобы отправить новое содержимое, мы просим отправить файлы Markdown для нового содержимого руководства в другой репозиторий Dynamics 365 Patterns and Practices. Таким образом, мы можем убедиться, что эталонная архитектура или шаблон рассматриваются другими экспертами по темам. Существуют различные шаблоны для выбора, и если вы хотите внести свой вклад в содержимое бизнес-процессов, существует другой процесс.

Шаблоны

Корпорация Майкрософт предоставляет шаблоны в двух расположениях в зависимости от типа шаблона:

С течением времени мы добавим дополнительные шаблоны и рекомендации. Мы рекомендуем подписаться на репозитории или сохранить их со звездочкой, чтобы вы получали уведомления об изменениях в них.

Поделитесь своим отзывом на вкладке https://github.com/microsoft/dynamics365patternspractices/discussions в репозитории Dynamics 365 Patterns and Practices.

Если у вас еще нет учетной записи GitHub, ознакомьтесь с руководством участника Microsoft Learn.

Подсказка

Просмотрите исходные файлы в репозитории https://github.com/MicrosoftDocs/dynamics365-guidance . Узнайте, как мы структурируем различные типы статей, чтобы ваши статьи следовали одной структуре. Таким образом процесс проверки выполняется быстрее.

Архитектуры

Мы приветствуем вклад в руководство по архитектуре, включая идеи решения и шаблоны проектирования. Если у вас есть рекомендация или справочная реализация, отправьте свое предложение команде Azure или нам в Dynamics 365.

Чтобы внести новые статьи в руководство по архитектуре Dynamics 365, выполните следующие основные действия:

Корпорация Майкрософт обрабатывает статью и публикует ее в рамках документации по Dynamics 365 .

Общие сведения о руководстве по работе с корпорацией Майкрософт см. в Центре архитектуры Azure. Указания для участников создания контента см. в статье Добавление контента для Центра архитектуры Azure.

Репозиторий GitHub dynamics365-docs-templates содержит следующие шаблоны Markdown для руководства по архитектуре в папке шаблонов рекомендаций :

  • Обобщенный шаблон архитектуры: обобщенный шаблон архитектуры выступает в качестве основной архитектуры с общим решением, которое применяется ко многим сценариям. Например, идеи решений могут строиться на статье об архитектуре, рассматриваемой через призму определенного отраслевого или партнерского решения. В этом случае каждая идея решения будет сопровождаться ссылкой на архитектуру. Шаблон основан на шаблоне руководства по архитектуре Azure. Используйте его для различных типов архитектур, включая эталонные архитектуры.

  • Идея решения. Идеи решения — это "небольшие" архитектуры реализаций Dynamics 365. Они предоставляют краткие обзоры решений с помощью служб Dynamics 365 и Azure. Каждая идея решения содержит следующие элементы:

    • Схема архитектуры
    • Поток данных
    • Компоненты, то есть список используемых служб
    • Список участников
    • Ссылки на следующие шаги и связанные ресурсы, такие как связанные руководства и архитектуры
  • Пример решения. Примеры решений — это примеры рабочих нагрузок со средними архитектурами. Они помогут читателям разработать решения для конкретных проблем в реализации Dynamics 365. Примеры решений предоставляют практические рекомендации по архитектуре на основе реальных примеров клиентов. Цель состоит в том, чтобы сократить кривую обучения клиентов, рассказав им историю другого клиента, который имел то же путешествие. Они включают разделы из шаблона "Идея решения " и добавляют следующие разделы:

    • Альтернативные варианты, другие службы, которые можно подключить к архитектуре, вместо этого
    • Соображения, рекомендации, которые соответствуют нашей структуре "Success by Design" и, по желанию, включают развертывание
  • Шаблон конструктора: шаблоны проектирования Dynamics 365 решают конкретные проблемы в реализации и основаны на определенном сценарии или рекомендациях. Используйте этот шаблон для записи шаблона бизнес-процессов. Кроме того, используйте шаблон Word в dynamics365patternspractices/templates/business-processes.

Вклады бизнес-процессов

Термин бизнес-процесса охватывает широкий спектр структурированных, часто последовательностей, действий или задач для достижения предопределенной цели организации. Термин также может ссылаться на совокупный эффект всех шагов, прогрессируя в направлении бизнес-цели. Бизнес-процессы характерны для решений, которые включают в себя Dynamics 365. Мы считаем, что этот новый тип контента создает структуру, которая помогает клиентам и партнерам лучше подготовиться к внедрению Dynamics 365. Каждый бизнес-процесс включает схему стандартного потока бизнес-процессов. Разделы документа описывают шаги конфигурации и сущности данных, используемые в каждом из них. Каждый шаг ссылается на соответствующую страницу в документации по продукту, а все документы имеют ссылки на следующие шаги и связанные ресурсы, чтобы помочь читателям в процессе обучения.

Мы структурировали бизнес-процессы в каталоге. Каталог бизнес-процессов — это книга Excel, используемая корпорацией Майкрософт для упорядочивания и приоритета нашей работы над документацией по бизнес-процессам. Формат Excel, так как он упрощает сортировку и фильтрацию записей. Мы также считаем, что наши партнеры могут использовать книгу Excel для организации своих процессов адаптации, своих проектов реализации и собственных бизнес-процессов.

Скачайте последнюю версию каталога.https://aka.ms/BusinessProcessCatalog

Замечание

Если вы хотите внести свой вклад в бизнес-процессы, зарегистрируйте свою работу, прежде чем начать уменьшать риск того, что кто-то другой работает над тем же бизнес-процессом. Чтобы зарегистрировать вашу работу, отправьте запрос на GitHub через https://github.com/microsoft/dynamics365patternspractices/issues.

Сведения о том, что содержит каталог

Каталог определяет шесть уровней содержимого:

  1. Сквозные процессы

    Комплексный процесс представляет полный поток действий от начального триггера до окончательного результата. Он охватывает все промежуточные этапы и подпроцессы, необходимые для достижения бизнес-цели. Мы определили 15 полных сценариев. Мы описываем сценарии в бизнес-терминах, а не с точки зрения технологии программного обеспечения.

    В вводной статье по каждому сквозному процессу описывается, что мы думаем о сквозном процессе. Мы перечислим ключевых заинтересованных лиц и как Dynamics 365 помогает комплексному процессу. Мы также предоставляем обзор, а также схему потока бизнес-процессов о том, как комплексный процесс взаимодействует с другими комплексными процессами. Вводные сведения содержат предварительные требования для реализации решения для поддержки комплексного процесса.

  2. Области бизнес-процессов

    Каждый комплексный сценарий охватывает две или несколько областей бизнес-процессов. Этот уровень представляет собой значительную группу связанных действий, которые способствуют общей цели, и он предоставляет логический способ группировать бизнес-процессы. В большинстве случаев области бизнес-процессов разделены основными функциями или отделами в организации. В настоящее время каталог определяет более 100 областей бизнес-процессов.

  3. Бизнес-процессы

    Термин бизнес-процесса охватывает широкий спектр структурированных, часто последовательностей, действий или задач для достижения предопределенной цели организации. Термин также может ссылаться на совокупный эффект всех шагов, прогрессируя в направлении бизнес-цели. Каждый бизнес-процесс описывает функцию или процесс, поддерживаемый Dynamics 365. До сих пор мы определили более 800 бизнес-процессов. Некоторые бизнес-процессы применимы к одному приложению Dynamics 365, и процесс может быть уже описан в документации по этому приложению. Собирая все бизнес-процессы в руководстве, мы надеемся предоставить единую точку входа со ссылками на соответствующее содержимое продукта.

  4. Сценарии

    В Dynamics 365 сценарии представляют собой шаблоны повторяемых конфигураций, которые поддерживают конкретный бизнес-процесс. К ним относятся наиболее распространенные варианты использования, сценарии и отрасли. Часто существует множество способов реализации Dynamics 365 в соответствии с вашими бизнес-требованиями. Назначение шаблонов — предоставить базовую схему для каждой конкретной реализации. Мы определили более 3000 сценариев и шаблонов, и мы ожидаем, что это число будет расти со временем.

  5. Системные процессы

    Системный процесс — это часть бизнес-процесса, использующего определенную форму, страницу или элемент пользовательского интерфейса в Dynamics 365.

  6. Тестовые случаи

Тестовый случай — это подробный набор условий и шагов, используемых для определения правильности программного приложения или системных функций. Это важная часть процесса тестирования программного обеспечения, предназначенная для обеспечения соответствия программного обеспечения его требованиям и выполнения должным образом. Тестовые случаи используются для выявления дефектов, обеспечения качества и проверки поведения программного обеспечения в соответствии с различными условиями.

Существуют шаблоны Word для каждого типа контента. Инструкции форматируются красным цветом, окруженным квадратными скобками, как показано в следующем примере:[Text in red] Удалите эти инструкции при завершении документа. Текст, выделенный желтым цветом, должен быть заменен или изменен вами. Не изменяйте текст, который не выделен желтым цветом и не отформатирован красным цветом. Эти стандартные фразы помогают пользователям распознавать шаблон, чтобы они могли сканировать и находить содержимое, которое они ищут проще.

Дополнительные сведения о каталоге бизнес-процессов см. в руководстве по бизнес-процессу. При необходимости просмотрите TechTalks , где мы говорим о том, как можно использовать каталог бизнес-процессов и внести свой вклад в библиотеку содержимого.

Отправка вашего вклада

Внутри корпорации Майкрософт мы работаем над тем, чтобы преобразовать внутренние заметки, годы опыта и различные документы в руководство по бизнес-процессу. Мы очень приветствуем вклад сообщества.

Существуют различные шаблоны для отправки вкладов на основе типа статьи. Участники должны выбрать правильный шаблон для соответствующего типа статьи, к которой они хотят внести свой вклад. Шаблоны доступны в виде файлов Word, именуемых для объяснения того, какой тип статьи предназначен для шаблона.

Признание вклада участников

Платформа Microsoft Learn отображает как внутренних, так и внешних участников в верхней части каждой статьи, если они отправили свой вклад через GitHub. Некоторые пользователи участвуют в других способах, поэтому мы добавим раздел "Участники " в конце статьи.

В разделе "Необязательные участники" перечислены ключевые участники с их именем и ссылкой на свой профиль LinkedIn или другой профиль, если они предоставили его. На следующем снимке экрана показана анонимная версия раздела "Участники " в статье Центра архитектуры Azure.

Снимок экрана: пример раздела

Вот как выглядит в Markdown.

## Contributors

*This article is maintained by Microsoft. It was originally written by the following contributors.*

Principal author:

* [Author's Name](https://www.linkedin.com/in/author-account/) | Author's job title or similar  

Other contributors:

* [Contributor's Name](https://www.linkedin.com/in/contributor-account/) | Contributor's job title or similar  
* [Contributor's Name](https://www.linkedin.com/in/contributor-account/) | Contributor's job title or similar  

Включение в список участников таким образом является необязательным. В корпорации Майкрософт рекомендуется использовать раздел "Участники" , если внешние участники могут отправлять новое содержимое, например эталонные архитектуры и шаблоны проектирования, с помощью других средств, кроме GitHub.