Рабочий процесс для управления содержанием справки, написанным внешними сотрудниками

Question

Мы разрабатываем приложение WPF, которое имеет что-то вроде контекстно-зависимой справки. Содержимое страниц справки в настоящее время написано в виде текстовых документов внешними коллегами (скажем, биологами), а затем разработчиками переведено в код xaml. Этот процесс утомителен и подвержен ошибкам, потому что биологи не видят код xaml, а документы Word нельзя легко найти и отследить в системе контроля версий.

Поэтому мы хотели бы улучшить этот процесс и сохранить контент в одном месте, в формате, который

• легко редактировать (желательно с помощью редактора wysiwyg),
• хранится в простом формате ASCII (для сравнения / контроля версий) и
• может быть автоматически включен в качестве ресурса в наше приложение C#.

Решением может быть каркас, внешний инструмент или любая другая идея. Формат должен поддерживать простую визуализацию html, такую ​​как полужирный и курсив, верхние индексы и т. Д., А также изображения.

Answer 1

Я предлагаю использовать Flow Documents:

• Это технология WPF, поэтому вы будете использовать хорошо известный инструмент.
• Потоковые документы можно редактировать в элементе управления RichTextBox WPF. Вы можете получить доступ к отредактированному документу потока через свойство RichTextBox.Document. Затем вы можете сохранить его в файл XAML с помощью XamlWriter. Принимая во внимание все это, вы можете легко и быстро создать простое приложение для ваших внешних коллег.
• Наконец, вы можете загрузить сохраненные файлы XAML в элемент управления FlowDocumentReader для их отображения. Это описано здесь.

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

В качестве альтернативы вместо потоковых документов вы можете использовать формат RTF. RichTextBox может также использоваться для редактирования этого вида документов.