タグ付けされた質問 「help-documentation」

4
example.orgに相当する電話番号は何ですか?
RFC 2606標準では、ドキュメントの例として使用する目的で、ドメイン名example.org、example.netおよびexample.comが予約されています。 例として使用できる電話番号(国コードを含む)に相当するものは何ですか?たとえば、ユーザーに電話番号を入力するための形式の例を提供するためですか? 最良の場合、それは関連する規格によって電話番号の例として指定されたダミー番号であり、実際の加入者に起因するものではありません。

6
最短時間のレビューのためにコードを文書化するにはどうすればよいですか?[閉まっている]
閉じた。この質問はより集中する必要があります。現在、回答を受け付けていません。 この質問を改善したいですか?この投稿を編集するだけで1つの問題に焦点を当てるように質問を更新します。 去年閉鎖されました。 数か月後にコードの読み取りと閲覧を最小限に抑えるようにコードを文書化したい。 さまざまな種類のドキュメントがあることを知っています(ソースコードと外部、シーケンス図など)。 コードを効率的に文書化する方法を知りたいので、数か月後にコードを確認したいとき、コードの読み取りとコードフローの理解に費やす時間が少なくなります。

5
HTMLヘルプの代替案
現在、AsciiDocと呼ばれるシステムを使用しており、単純なテキストマークアップでドキュメントを作成できます。それから、複数の出力形式を生成できます。pdf出力とchm出力形式のみを使用します。 chmに代わるものがあるのだろうか?私が探しているのは、ソフトウェアでオフラインで使用できるものです(非常に多くのユーザーが非常に離れた場所にいるため重要です)。インデックス(ハイパーリンクされた用語を含むhtmlページと同じくらい単純にすることができます)があり、検索可能で、コードから特定のエントリを呼び出すことができるメカニズムが必要です(状況依存ヘルプと同様)。 この場合のPDFに対する2つのことは次のとおりです。 状況依存ヘルプはオプションではありません 一般的に、ドキュメントはかなり大きい PDFは、状況依存ヘルプよりも印刷されたドキュメントに適しています 私が望むのは、htmlを使用することです。htmlの唯一の問題は、キーワード検索を自動的に提供する方法がわからないように見えることです(ブラウザのctrl + f機能以外-もっとはっきりしたいのですが)。また、キーワードのハイパーリンクインデックスを自動的に生成する方法が見つからないようです。セクションタグがあるため、状況依存ヘルプは簡単です。デフォルトのブラウザに興味のあるページとセクションのURLを渡すだけで、そのページは正しいセクションまで読み込まれます。 私の要件はchmのようにひどく聞こえます-そうです。要件をchmからモデリングしました。私がchmが好きではない唯一の理由は、コードがmapidなどを使用してそれと対話する方法のためです。私のコードがドキュメントのコンテキスト依存部分にアクセスするために使用できるプレーンテキストリスト(自動的に生成されます)を保存することをお勧めします。 私は、html出力ファイルを調べて、見つかったキーワードのリストを単に含むインデックスページを生成するスクリプトを想定しています。明らかに、the、it、isなどのような単語を無視する単語除外メカニズムが必要です。この部分は比較的簡単に記述できます。2番目の部分には、HTMLテキスト内のキーワードとその場所のデータベースをまとめるための何らかのスクリプトが必要です。これは、ブラウザ内で検索メカニズムを提供するとともに、難しい部分になると思います。 代替案に関するアイデアをいただければ幸いです。私はウィキまたはウェブサーバーでホストされている静的なHTMLページのセットをどこかで使用したいと思っていますが、重要なオフライン使用要件があります。htmlをローカルドライブに配置するだけでは、必要な検索要件が提供されません。 編集: 私は、鉱業で使用されるソフトウェアを設計しています。鉱山の多くは非常に離れており、意味のある方法でインターネットにアクセスできません。pdf、html、chmには何も問題はありません(古くなっていることを除きます)。PDFファイルを正しい場所に表示できる場合(つまり、状況依存ヘルプ)、それを使用します。私はほとんど自分で書きたいと思っています-基本的にはポータブルwikiになります。そういえば、ポータブルwikiを提案する場合は、そのようなツールの使用経験のないエンドユーザーについて考える必要があります。それは非常にシンプルでなければなりません。それはchmの美しさであり、連携するのは苦痛ですが、エンドユーザーはそれを気に入っています。
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.