Fluxo de trabalho para transformar o conteúdo Wiki em um manual do sistema

https://stackoverflow.com/questions/618508

wiki
manuals

03-07-2019
|

Pergunta

Estamos no meio da implantação de um novo sistema de software para o lote de usuários em lote de lugares (200 + usuários com mais de 8 países). No passado temos escrito um manual para os usuários, em seguida, atualizá-lo a cada tantas vezes. Isso funciona bem, em que todos os usuários ahve o mesmo manual, que abrange as principais coisas, mas ele tem seu problemas, como ele não é atualizado, que muitas vezes, às vezes perca atualizações, e alguns usuários terão cópias antigas.

Nós temos falado sobre como usar um wiki durante as fases de teste e implantação de construir uma base de conhecimento sobre o sistema. Idealmente, nós tinha então como uma maneira de converter isso em algum tipo fo documento eletrônico que podemos então 'pretty-fie' e enviar como o manual oficial, bem como permitir que os usuários usar e atualizar o wiki.

Tem mais alguém fez algo semelhante? Todas as sugestões para sistemas wiki, fluxos de trabalho, formatos de documentos, etc?

Solução

a maioria dos wikis exportação suporte via PDF por exemplo:.

Outras dicas

Você pode escrever algo que gera LaTeX do wiki e torna um manual em PDF. Com pacotes como hyperref você pode reter referências cruzadas como hiperlinks.

Além disso, você pode integrar o conteúdo de várias fontes, tais como um dicionário de dados para o documento LaTeX, que podem ser misturados e combinados com o conteúdo wiki. Você também pode definir a arquitetura para que ele possa suportar referência cruzada que vai de qualquer maneira.

Framemaker também poderia apoiar esta usando gerado arquivos MIF "noreferrer nofollow", e você também pode usar Lout de forma semelhante ou converter o seu conteúdo wiki para docbook, que permitem que você use qualquer uma das muitas opções de renderização disponíveis para esse formato.

Como um aparte, as seguintes publicações StackOverflow discutir vários sistemas para a manutenção de documentação.

Madcap alargamento é uma ferramenta de autoria ajuda-e-manual que usa HTML para o fonte de cada tópico. Você poderia muito facilmente fazer uma importação em massa das páginas Wiki. Exigira, então, alguma limpeza, mas depois que você tem um sistema de fonte única bom que saída pode CHM, web-navegável ajuda, PDF, DOC / DOCX, etc.

Como você está armazenando a fonte de ajuda no momento? É arquivos de MS Word, MS ajuda, LaTeX?

Se você colocar seus arquivos de origem de ajuda sob controle de versão, então você vai obter todos os benefícios de um wiki sem ter que migrar para um novo sistema - as pessoas podem fazer edições para os arquivos de ajuda facilmente - essas alterações podem ser rastreados, reverteu etc . e você obter os manuais embelezados como antes.

Eu segui as ligações do Nó e me deparei com algumas páginas do MediaWiki que eu achava que eram dignos de nota.

Eu dei um anterior resposta que pode ser útil para o "wiki para PDF" parte - olhada usando o código-fonte PediaPress aberto ou funcionalidade. Você pode obter ODFs a partir dele também, embora seus PDFs já são bastante bonita (mas você pode querer rebrand-lo e remodelar-lo para sua empresa suponho).

Licenciado em: CC-BY-SA com atribuição

Não afiliado a StackOverflow