Написание корпоративной документации в Markdown и pandoc

1257
TheSavo

Фон

У меня было несколько друзей, которые включили меня markdownи pandocнаписали документацию. На моей нынешней работе мы используем Microsoft Word для написания неструктурированных одноразовых документов для наших конечных пользователей. Я хотел бы начать писать их в уценке по следующим причинам.

  1. отделение контента от структуры.
  2. возможность использовать системы контроля изменений для отслеживания обновлений
  3. Создайте стандартный шаблон, который включает логотип, стандартный текст компании, макет, общий для всей последующей документации.

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

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

Вопрос

Мне нужна помощь в добавлении элементов, таких как логотип, и стандартного текста, который можно добавить в шаблон HTML или PDF. Кроме того, я хотел бы определить макросы, например, инкапсуляция слова в !челки будет выделять это слово в соответствии с набором правил, таких как клавиши на клавиатуре или кнопки программного интерфейса. Напротив, инкапсуляция слова в &амперсанды изменила бы стиль, чтобы обозначить имя элемента меню GUI.

2
Это, вероятно, хорошая цель, но вы не задали вопрос. Stephen Jennings 12 лет назад 5
Этот вопрос * путь * к общему. Пожалуйста, прочитайте [учебник] (https://www.google.se/search?q=markdown+tutorial+%2Bpandoc) и вернитесь, если у вас есть конкретные вопросы. Nifle 12 лет назад 0
Если вы все еще ищете, это может помочь: http://superuser.com/questions/87273/desktop-app-for-wiki-like-markdown-markups/87277#87277 cregox 11 лет назад 0

0 ответов на вопрос

Похожие вопросы