Escrevendo documentação corporativa em Markdown e pandoc [closed]

2

Antecedentes

Eu tive alguns amigos que me ligaram para markdown e pandoc para escrever a documentação. No meu trabalho atual, usamos Microsoft Word para escrever documentos de instruções não estruturados e únicos para nossos usuários finais. Eu gostaria de começar a escrevê-las no markdown pelas seguintes razões.

  1. separação do conteúdo da estrutura.
  2. a capacidade de usar sistemas de controle de alterações para rastrear atualizações
  3. Crie um modelo padrão que inclua um logotipo, texto da empresa padronizado e um layout comum a toda a documentação subsequente.

Gostaria de criar alguns modelos que permitirão que todos os documentos contenham o mesmo fluxo de informações para nossos usuários. O objetivo é adicionar um visual professoral à nossa documentação de usuário do departamento de TI.

Eu imagino que um wiki hospedado na empresa pode ser suficiente, mas os tomadores de decisão não permitirão isso neste momento.

Pergunta

O que estou procurando é ajudar na adição de elementos como um logotipo e texto padrão que pode ser adicionado a um modelo HTML ou PDF. Além disso, gostaria de definir macros como encapsular uma palavra em ! bangs que destacaria essa palavra de acordo com um conjunto de regras, como teclas em um teclado ou botões de uma GUI de software. Em contraste, o encapsulamento de uma palavra em & E comercial mudaria o estilo para significar o nome de um elemento do menu GUI.

    
por TheSavo 23.05.2012 / 03:45

0 respostas