私は vb6 デスクトップ アプリケーションに基づいてユーザー マニュアルを作成しようとしています。ソフトウェアの使用方法については、主に非技術者が使用する必要があり、クライアントに何を購入しているのかを示すためにも必要です。

ベストプラクティスに関するこの以前の議論を見たことがありますが、何を書くか、何を含めるかについてより良い感触を得ることができるように、実際の製品用のしっかりした便利なユーザーマニュアルを探しています. デスクトップ アプリケーションや vb6 ベースである必要はありません。インスピレーションを探しているだけです。

ありがとう。

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

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

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

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

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

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

ありがとう！

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

マクロ記録とスクリーンショット撮影機能を組み合わせたソフトウェアを探しています。

多数のスクリーンショットが記載されたソフトウェアマニュアルがあります。新しいバージョンのソフトウェアがリリースされたら、ほとんどのスクリーンショットを更新する必要があり、手動で更新する必要があります。今、私たちはマニュアルをいくつかの言語に翻訳し始め、撮るスクリーンショットの数は10倍に増えました。このプロセスを自動化したいと思います。

ソフトウェア内のボタンをクリックしてプログラムウィンドウのスクリーンショットを撮るマクロなどが記録されます。さらに良いことに、それほど重要ではありませんが、各スクリーンショットの名前を個別に指定できます。

そのようなものは存在しますか？

いくつかのアプリで美しいユーザーマニュアルを見ました。そこで、ユーザーが新しいページに入ると、ユーザーがクリックする必要のある領域を除いて、ほとんどの表面が灰色になっています。また、ここでユーザーにはいくつかのヒントが表示されます。たとえば、この画像のように：

ユーザーが明るい領域をクリックすると、次のヒントが表示されます。たとえば、次のようになります。

今私の質問は次のとおりです：これらのようなユーザーマニュアルまたはユーザーヒントをどのように作成できますか？

gcc の場合、マニュアルでは、 、 などが特定の最適化引数 ( 、 など) に関して何に変換されるかを説明してい-O3ます。-Os-funswitch-loops-fcompare-elim

clang について同じ情報を探しています。

私はオンラインで見て、man clang一般的な情報のみを提供します（-O2より積極的-O1に-Os最適化し、サイズを最適化します...）、またここでスタックオーバーフローを見て、これを見つけましたが、引用されたソースファイルに関連するものは何も見つかりませんでした.

編集：答えを見つけましたが、すべての最適化パスと によって選択されたパスを文書化したユーザーマニュアルへのリンクを誰かが持っているかどうかに興味があります。現在、このパスのリストを見つけましたが、最適化レベルについては何も見つかりませんでした。-Ox

私の質問は 2 つの部分に分かれています。

最初の部分: 2 つのブロブgit rebase

git rebase -i HEAD^nここで、リベースnする前のコミットの数を意味します。

でも、たまに見かけgit rebase -i <branch> HEADます。<branch>その場合 - 追加されたパラメーターはどのように違いますか?

後半: git rebase の man ページ

だから....マニュアルページをチェックしたところ、次のように表示されました。

その man ページには[<upstream> [<branch>]]、最初の部分に対する私の質問に答えるかもしれないと思われる が表示されます。

<>しかし、これについての奇妙な点は、必須パラメーターを[]意味し、オプションのパラメーターを意味することを知っていることです。では[<upstream> [<branch>]]、オプション パラメータの中に必須パラメータがあります。これは何を意味するのでしょうか？

doxygen を使用して自分のライブラリのユーザー マニュアル/チュートリアルを作成しようとしています (doxygen 自体のユーザー マニュアルに似たものです! -リンク) 。

ドキュメント階層を作成するために、.mdファイルのサブページを使用しました。mainpage私は最終的に OpenCV (リンク) に似たものになりました。これは非常に見栄えがしますが、doxygen ユーザー マニュアルのような多くの機能はまだありません。たとえば、左側にページ/セクション インデックス、右側にページごとの目次があります。

拡張可能なインデックス/目次を生成し、doxygen を使用してすべてのページに添付する方法はありますか (リンクのように)? これを行うより良い方法はありますか？他のヒントはありますか？