問題タブ [user-guide]

ソフトウェアアプリケーションのユーザーガイドを作成するのに役立つリソースへのリンクを探しています。私は、ガイドを構成し、適切な文体を与え、全体を通して優れたルックアンドフィールを確保するのに役立つ何かを求めています。

私が構築している大規模な Web アプリケーションでは、詳細なユーザー ガイドを作成する必要があります。最初に考えたのは wiki でしたが、私が見たものは、CMS で見たカスタマイズの容易さに欠けており、必要のない余分な機能がたくさんあります。

ドキュメントを編集するユーザーの数は少なく、閉じられていますが、技術者以外のユーザーが編集できる必要があります。ページ数は 50 ～ 100 の間になると思われます。また、検索可能である必要があります。また、Web アプリからリンクするための読みやすい URL があれば、それもプラスになります。

現時点では、WordPress が最適だと思いますが、これは、複数のページを持ち、おそらくブログを持たないというよりは、ほんの一握りのページでブログを書くことに向いているようです。私たちは Java と PHP の経験が最も豊富ですが、言語の要件はありません。ビジュアルのカスタマイズ以外に主要なコーディングを行う必要はないと考えているため、言語があまり重要でないことを願っています。繰り返しますが、私は最高の汎用 CMS を探しているわけではなく、ユーザー ガイドにとって最も簡単なものを探しているだけです。

Apache C++ 標準ライブラリ ユーザー ガイドのダウンロードして印刷できるバージョンはどこにも見つかりませんでした。利用できる唯一のオプションは、オンラインのフレーム バージョンとフレームなしバージョンです。wget にスクリプトを記述してそれらを照合するのはやり過ぎのようです。

ダウンロードして印刷できる PDF またはその他の形式が存在するかどうかを知っている人はいますか?存在しない場合は、なぜですか?

PS - stdcxx lib をダウンロードすると html ファイルが得られることはわかっていますが、それでもブラウザに限定されています。ドキュメントをすぐに参照できるように印刷したいと思います。

利用可能なオープン ソースのユーザー ガイド タイプの作成ソフトウェアはありますか? それとも、ウィキ タイプ システムを使用するのが最善でしょうか? 私たちは、Web フロント エンドを介してオンザフライでユーザー ガイドを作成し、ネット上でアクセスできるようにしたいと考えています。それとも、Wiki を使用してこれを達成するのが最善でしょうか? ありがとう

Kohana フレームワークを使用して構築しているアプリケーションのユーザーガイドを作成したいのですが、この目的のために Kohana ユーザーガイド モジュールを使用できる方法があるかどうか疑問に思っています。

作成する新しいモジュールのユーザーガイド情報を追加する方法と、API にクラスを含める方法は理解していますが、アプリ開発者ではなく、実際のアプリケーション ユーザー向けに別のユーザーガイドを作成したいと考えています。

最初は、APPPATH/guide のメイン ユーザーガイドにアプリのヘルプ ページを追加してみようと思っていました。「application/guide」ディレクトリを追加して、そこに menu.md というファイルを配置しようとしましたが、ユーザーガイドの Kohana メニューが置き換えられてしまいました。ファイルの名前を menu.myapp.md に変更した後、まったく表示されません。

そのため、modules/userguide/guide/menu.md を編集してアプリのセクションを追加し、同様に各アプリ コンポーネントのマークダウン ファイルを追加することができます。しかし実際には、Kohana のドキュメントはアプリ ユーザーには関係ないため、アプリ ユーザー用に完全に別のユーザー ガイドを作成する方がはるかに優れています。

これについて最善の方法は何ですか？ユーザーガイド モジュール全体の複製を作成し、ルーティングを変更する必要がありますか? または、1 つのバージョンのモジュールを使用して両方のユーザーガイドをセットアップする方法はありますか? それとも、まったく間違ったツリーを吠えていますか? アプリの「ヘルプ」ページを作成するのに適した他のモジュール/アプローチはありますか?

よろしくお願いします。

私は Hyperion を初めて使用し、現在ユーザー ガイドから共有サービスについて学習しています。共有サービスのタスクとは何かについての情報を読みましたが、それについても調べました。今、私は1つの質問があります:

Hyperion の共有サービスの代替名は何ですか? 返事してください 。

Google 開発者サイトと SO の両方でこの質問に対する答えを見つけようとしていますが、これまでのところ満足のいく答えを見つけることができません。

アプリケーションをダウンロードするユーザーに、アプリケーションの特定の部分のセットアップ方法と外部データのロード方法に関する「ユーザー ガイド」を提供したいと考えています。簡単なステップバイステップガイドにスクリーンショットを追加したいと思います。

これを行うための固定フレームワークはありますか? デバイスのブラウザにロードするいくつかのページでアプリを出荷できますが、電話のブラウザでは、電話のスクリーンショットを見るのはあまり「読みにくい」場合があります。PCから閲覧できるURLの方が良いでしょうか？または、アプリケーション内の単なるテキスト ウィンドウが最適な場合もあります。ここにいる誰かが、過去にうまくいったかもしれないアイデアを持っていることを願っていました。

お願い助けて。休憩アプリの例を起動しようと長い間試みましたが、これはできません。ジャージのユーザーガイドを使用して、私はそれに行き詰まっています。例は次のとおりです。

しかし、私は理解できません。startServer() メソッドを持つ Main クラスは何ですか? このクラスのインポートはありません。

アプリにユーザー ガイドを実装したいと考えています。しかし、私には明確ではありません。それを行うための最良の解決策は何でしょうか。ユーザー ガイドについての私の考えは、html faq に基づいています。ユーザー ガイドは、上部に目次があり、その後に実際のガイドが続く別のアクティビティです。目次の各項目は、ユーザー ガイドの特定のアンカーへのリンクです。また、活動にはトップに戻るボタンがあります。私の質問は、これらすべての機能をどのように実装すればよいですか? 典型的な View サブクラスを使用する必要がありますか、それとも webview を使用して html ドキュメントを実装しようとする必要がありますか (Web 関連の API を使用したことがないため、offlane html ドキュメントを実装できるかどうかわかりません)

編集：教訓。これからは、特定のコーディングの問題についてのみ質問を公開します。

Ps 多分誰でも、より一般的な質問や提案について話し合うことができるサイトを提案できますか?