8

私は、ソフトウェアのエンドユーザードキュメントを生成する必要があるプロジェクトに取り組んでいます。来年のある時点で、私がこのドキュメントを書いているソフトウェアは廃止されます。したがって、私はプロ級のマニュアルに多くの時間を費やしたくありません。これは、大学の大学院生と数人の社内専門家が目にするものです。それが十分に良くて有用であるならば、私はそれを無料のドキュメントとしてオープンソースコミュニティにフィードバックするかもしれません。

HTMLのマニュアルがぴったりだと思っていました。このソフトウェアはPHPで記述されているため、使用しているユーザーは誰でもWebブラウザーを開いてすぐに使用できます。これはまた、私または他の誰かがマニュアルのページをソフトウェア自体に統合する可能性につながります。

このソフトウェアのwikiを作成/使用することに興味はありません。私が本当に探しているのは、通常のドキュメントのように記述して、単純なHTMLを生成できるソフトウェアです。DreamweaverやFrontpageのようなソフトウェアがあることは知っていますが、ドキュメントの作成プロセスを簡単にするために設計されたものに特に興味がありました(スクリーンキャップとビデオを取得するプロセスが単純な画像/ビデオ編集と統合されています)。

別のアプローチ(HTMLドキュメント以外)の方が良いと思われる場合は、ぜひお聞かせください。別のアプローチがあり、それを実現するための優れたソフトウェアソリューションを知っていると思われる場合は、お知らせください。

アプローチとそれを達成するためのソフトウェアに対する私の主な願望は

  • 展開の単純さ(HTMLページには特別な設定は必要ありません。ヘルプディレクトリは、すべてのマニュアルページとともに簡単に展開できます)
  • 利用するのに特別なソフトウェアは必要ありません(HTMLはWebブラウザを持っている人なら誰でも読むことができます)
  • ドキュメントの作成のしやすさ/小さな学習曲線(比較的小さなプロジェクトで作業するための複雑なソフトウェアの学習に多くの時間を費やしたくない)
  • テキスト、ビデオ、および画像を1つのドキュメントに結合する機能(HTMLページは明らかにこれらすべてを一緒に表示することをサポートしています)

ありがとう!

@Lie Ryan:「MediaWikiはすべてのテキストとデータ(コンテンツページ、ユーザーの詳細、システムメッセージなど)をデータベースに保存します...」これは避けたいことです。ウィキは素晴らしくて便利だと思いますが、私は非常に低いオーバーヘッドで静的データを提供することに興味があります。

4

4 に答える 4

7

ユーザーマニュアルを書く必要があるときはいつでも(つまり、プロジェクトを終了するたびに)、Markdownを使用するのが好きです。最小限のCSSと組み合わせると、非常に使いやすくなります。

Markdownは、Webライター向けのテキストからHTMLへの変換ツールです。マークダウンを使用すると、読みやすく、書きやすいプレーンテキスト形式を使用して記述し、それを構造的に有効なXHTML(またはHTML)に変換できます。

したがって、「マークダウン」は2つのものです。(1)プレーンテキストのフォーマット構文。(2)プレーンテキストのフォーマットをHTMLに変換するPerlで書かれたソフトウェアツール。

于 2010-09-27T23:45:05.240 に答える
2

これはあなたのすべての要件を正確に満たすわけではないと思いますが、私はSphinxの大ファンです。ドキュメントはReSTで記述し、HTMLおよびPDFバージョンを非常に簡単に生成できます。HTML生成はテンプレートを使用するため、かなりカスタマイズ可能です。また、そのようなものが好きな私たちにとっては、プレーンテキストバージョン(ReSTはそのままでもある程度読みやすい)があるという追加の利点があります:)

于 2010-09-27T20:47:14.293 に答える
1

マニュアルをXMLで記述し、docbookのようなものを使用します。これにより、コンテンツで必要なことをすべて実行し、独自の方法でプレゼンテーションを生成できます。

docbookからHTMLツールまでのチュートリアルはたくさんあります。

編集:OOがdocbookに保存できることを忘れました。

于 2010-09-27T20:26:12.903 に答える
0

OpenOfficeで書いてPDFに公開することをお勧めします。PDFは、おそらくHTMLよりも優れており、プラットフォームに依存せず、複数のクライアントやオペレーティングシステム間でほぼ同じように見えます。本当にビデオが必要な場合は、YouTubeやPDFからwhat-have-youなどの外部Webサイトにリンクできます。

于 2010-09-27T20:39:28.473 に答える