問題タブ [manuals]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
documentation - あなたのチームは、ユーザー マニュアルを作成するためにどのツールを使用していますか?
基本的なリクエストは次のとおりです。
- 人間が読める / テキスト形式 (簡単なバージョン管理のため)
- オンライン（コラボレーション用）
- 簡単な書式設定 (マークダウンはOK、html は多すぎる)
- 厳密な書式設定 (作成者が新しいタイプのタイトル、箇条書きなどを発明しないようにするため)
- PDF、HTMLにエクスポート可能
- 簡単なバックアップと展開 (読み取り専用バージョンとしてお客様のサイトに「展開」できるようにするため)
ある種の wiki エンジンを使用することを考えていますが、ストレージにファイルを使用するか、顧客への「展開」の他の手段が必要であり、インストール/メンテナンスが簡単である必要があります。また、無料/安価である必要があります（合流点は高すぎます）
助言がありますか？
編集: コードを文書化するためのツールを探しているわけではありません。Sandcastle を使用してカバーしています。
pdf - ユーザーマニュアルを作成するためのアプリケーション (マークアップ言語ではありません)
ユーザーマニュアルを作成するための推奨プログラムを教えてください。マークアップ言語 (LaTeX や DocBook など) ではなく、Scribus のようなインタラクティブな言語です。マニュアルを更新するのは私だけではないので、ソフトウェアは初心者が簡単に習得できるものである必要がありますが、それでもいくつかの高度な機能 (外部ソース/テーブルからのテキストへのリンク、マスターページ/テーマの処理など) を備えている必要があります。 .
よろしく、オスカー
wiki - Wikiコンテンツをシステムマニュアル化するワークフロー
私たちは、新しいソフトウェア システムをさまざまな場所の多数のユーザー (8 か国で 200 人以上のユーザー) に展開している最中です。過去にユーザー向けのマニュアルを作成し、それを頻繁に更新しました。すべてのユーザーが同じマニュアルを持っていて、主要な事柄をカバーしているという点で、これは問題なく機能しますが、頻繁に更新されない、時々更新を見逃す、一部のユーザーは古いコピーを持っているなどの問題があります。
システムに関するナレッジ ベースを構築するために、テスト段階と展開段階で wiki を使用することについて話し合ってきました。理想的には、それを何らかの形で電子ドキュメントに変換し、それを「きれいに加工」して公式マニュアルとして送信し、ユーザーが wiki を使用および更新できるようにしたいと考えています。
他の誰かが同様のことをしましたか? ウィキ システム、ワークフロー、ドキュメント形式などについて何か提案はありますか?
macos - すべての GNU Unix マニュアルを Mac のすべての Unix マニュアルと比較できない
すべての GNU Unix マニュアルと Mac の Unix マニュアルを sdiff で比較したいと思います。
たとえば、Mac のすべての Unix マニュアルを調べてから、それらをファイルに保存する方法がわかりません。
マニュアルが 2 つのファイルにある場合は、次のコードで比較できます。
おそらく、次のことができるように、Unixコマンド名のインデックスがいくつかあります
すべての GNU Unix マニュアルと Mac のすべての Unix マニュアルをどのように比較できますか?
[編集]
Mac のマニュアルは /usr/share/man/man[1-9]/* にあります。それらを猫にしようとすると、エンコードの問題が発生します。
もう 1 つの問題は、Coreutils のマニュアルの場所を見つけることです。
emacs - 設定ファイルとマニュアルの間をすばやく移動できません
男のマニュアルは以下を持っています
使用する構成ファイルを指定します。デフォルトは /private/etc/man.confです。（man.conf（5）を参照してください。）
manの/private/etc/man.confのPATHは太字で示されています。ファイルへのハイパーリンクである可能性があることを示唆しています。Emacsのように人の中で動くのはクールだろう。
人間のマニュアルから直接ファイルを入力することに成功していません。
人間で次のことを行わずに、人間のマニュアルから直接ファイルを移動するにはどうすればよいですか？
emacs - ターミナルから直接Emacsでマニュアルを開くことができません
TerminaltoEmacsで直接マニュアルを開きたい
次のコードをエイリアスとして.zshrcに入れましたが失敗しました
どうすればemacsのマニュアルを開くことができますか？
vim - VIMの通常モードで「K」ボタンをどのように使用しますか？
Kはマニュアルを開くために使用されます。使い方に興味があります。C、Java、その他のあらゆる種類のマニュアルに使用できますか？
makefile - $+ メイクファイル
GNU makefile の $+ はどういう意味ですか?
また、makefile を書くための良い参照マニュアルを教えてください。
mysql - MySQLマニュアルをMacにインストールできません
この質問はスレッドに基づいています。
マニュアルをファイル「v5.1（Maria）TGZ」としてダウンロードしました。ファイルをに移動しました/usr/share/man/。によってマニュアルにアクセスできませんでした
.tar.gzファイルには、READMEを含まないこれらのファイルが含まれています
ファイルを/usr/ share / man/mysqlにコピーしました。しかし、キーワードでマニュアルにアクセスできませんでしたmysql。
Manがアクセスできるように、ファイルはどこに置く必要がありますか？
MySQLのマニュアルをOSXLeopardにインストールするにはどうすればよいですか？