Wikiコンテンツをシステムマニュアルに変えるワークフロー

StackOverflow https://stackoverflow.com/questions/618508

  •  03-07-2019
  •  | 
  •  

質問

私たちは、新しいソフトウェアシステムを多くの場所の多くのユーザー（8か国で200人以上のユーザー）に展開している最中です。過去に、ユーザー向けのマニュアルを作成してから、頻繁に更新しています。すべてのユーザーが同じマニュアルを扱っており、主なものをカバーしているため、これは問題なく機能しますが、頻繁に更新されない、更新が見逃される、一部のユーザーが古いコピーを持っているなどの問題があります

テストと展開の段階でウィキを使用して、システムに関する知識ベースを構築することについて話してきました。理想的には、それを何らかの形で電子文書の形式に変換し、それを「かなり手に入れて」公式マニュアルとして送信し、ユーザーがウィキを使用および更新できるようにすることが望まれます。

他の誰かが同様のことをしましたか？ Wikiシステム、ワークフロー、ドキュメント形式などについての提案はありますか？

役に立ちましたか？

解決

ほとんどのウィキはPDFによるエクスポートをサポートしています。例：

他のヒント

Wikiから LaTeX を生成し、マニュアルをPDFにレンダリングするものを作成できます。 hyperref などのパッケージを使用すると、相互参照をハイパーリンクとして保持できます。

さらに、データディクショナリなどの複数のソースのコンテンツをLaTeXドキュメントに統合できます。LaTeXドキュメントは、Wikiコンテンツと混合して一致させることができます。どちらの方法でも相互参照をサポートできるように、アーキテクチャを設定することもできます。

Framemaker は、生成された MIF ファイル。また、 Lout 同様の方法で、またはWikiコンテンツを docbook を使用すると、その形式で使用できる多くのレンダリングオプションのいずれかを使用できます。

余談ですが、以下のStackoverflowの投稿では、ドキュメントを管理するためのさまざまなシステムについて説明しています。

Madcap Flare は、ヘルプと手動のオーサリングツールで、各トピックのソース。 Wikiページの大量インポートを簡単に行うことができます。その後、ある程度のクリーニングが必要になりますが、その後、CHM、Webブラウズ可能ヘルプ、PDF、DOC / DOCXなどを出力できる単一ソースシステムが用意されます。

現在、ヘルプソースはどのように保存していますか？ MS Wordファイル、MSヘルプ、LaTeXですか？

ヘルプソースファイルをバージョン管理下に置くと、新しいシステムに移行することなくウィキのすべての利点が得られます-ヘルプファイルを簡単に編集できます-これらの変更を追跡、元に戻すことができます。そして、以前のようにプリティファイドマニュアルを取得します。

Nodeのリンクをたどって、注目に値すると思われるいくつかのmediawikiページに出会いました。

以前の回答が役立ちました。 ＆quot; wiki to PDF＆quot;の場合一部-PediaPressのオープンソースコードまたは機能の使用をご覧ください。 ODFも入手できますが、PDFはすでにかなりきれいですが（ただし、会社のブランド変更とスタイル変更が必要な場合があります）。

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top