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

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

  • Статья

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

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

Отправка отзывов

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

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

Участие внешних пользователей в создании документации Майкрософт

Исходные файлы для нашего основного контента хранятся в общедоступных репозиториях 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, чтобы другие участники сообщества также могли повысить продуктивность и эффективность своих внедрений.

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

Как принять участие в создании контента

С ноября 2023 г. вы можете найти исходные файлы содержимого руководств 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.

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

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

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

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

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

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

  • Design pattern: в конструктивных шаблонах 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. Области бизнес-процессов

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

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

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

  4. Шаблоны

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

Дополнительные сведения о каталоге бизнес-процессов см. в разделе О руководстве по бизнес-процессам.

Отправка написанного контента

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

Репозиторий GitHub содержит шаблоны Microsoft Word, которые вы можете использовать для оформления своего контента. Все шаблоны Word находятся в папке /templates/business-processes. Эта папка также содержит шаблон PowerPoint, который можно использовать для разработки схем. В качестве альтернативы можно использовать Visio или другой конструктор.

Когда вы будете готовы отправить новую статью, заполните нашу форму и приложите свой файл или файлы.

При желании укажите свой профиль LinkedIn, чтобы мы могли упомянуть вас в качестве оригинального автора.

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

На платформе 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.