Участие в написании документации по Dynamics 365

Вы можете внести свой вклад в документацию по Microsoft 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. Наши партнеры и клиенты могут использовать его для подготовки к внедрению, а также для выработки навыков в новых областях или обучения нового персонала. Разработчики ПО могут использовать его в качестве платформы для продвижения своей интеллектуальной собственности или демонстрации своих отраслевых наработок.

Специалисты Microsoft — не единственные эксперты по реализации решений с 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.

Tip

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

Architectures

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

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

После этого мы в Майкрософт обработаем вашу статью и опубликуем ее в составе методической документации по Dynamics 365.

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

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

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

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

    • Схема архитектуры
    • Поток данных
    • Компоненты, то есть список используемых служб
    • Список авторов
    • Ссылки на следующие шаги и связанные ресурсы, например связанные руководства и архитектуры

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

    • Альтернативы (другие службы, которые можно подключить к архитектуре взамен описанных)
    • Соображения, рекомендации, которые соответствуют нашей структуре "Success by Design" и, по желанию, включают развертывание

  • Design pattern: в конструктивных шаблонах Dynamics 365 рассматриваются конкретные сложные моменты в реализациях. Они основываются на конкретном сценарии или лучшей методике. Этот шаблон можно использовать для описания бизнес-процесса. В качестве альтернативы можно использовать шаблон Word из папки dynamics365patternspractices/templates/business-processes.

Добавление контента по бизнес-процессам

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

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

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

Note

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

Содержимое каталога

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

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

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

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

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

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

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

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

  4. Scenarios

    В 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.

  • Last updated on