あなたは、ちょうど始めようとしているが、彼らの文章を文書化するためにどのツールを使用するかわからない、意欲的な技術ライターですか？ さて、あなたは正しい場所に来ました！
何よりもまず、技術文書とは正確に何であるかを理解しましょう。
技術文書は、理解するために博士号を必要とすべきではなく、より簡単な言葉と工学の観点から、技術文書は、技術製品または開発中または使用中の他の製品の取り扱い、機能、およびアーキテクチャを説明するあらゆるタイプの文書を指します。
ドキュメントには、1 ページの要件シートから、新しいオープン ソース フレームワークを文書化した分厚いリファレンス マニュアルまであります。今日、アプリ、API、SDK、およびほとんどのハードウェア製品のドキュメントがオンラインで利用できます。技術ドキュメントに最適なツールをリンクと共にリストアップしたので、それらの感触を得て理解を深めるために、さっそく始めましょうか。
HelpNDoc は使いやすく、かつ強力なオーサリングツールで、さまざまなニーズに対応できる汎用性があり、1 つのソースからさまざまなドキュメント形式を生成できます。
HelpNDoc には、ユーザー フレンドリーで非常に使いやすい環境で完全なヘルプ ファイル、マニュアル、ドキュメントを書くのに必要なすべてのツールがあります。
標準の Windows CHM ヘルプ ファイル、WEB ベースのドキュメント、iPhone に特化した Web サイト、および印刷可能な PDF や Word ドキュメントを生成できます。
特徴
– HelpNDoc により、ユーザーは単一のソース テキストを作成し、それを HTML ヘルプ、PDF、RTF、DocX、Qt ヘルプ、および HTML ドキュメント、また EPUB や Amazon Kindle 対応電子書籍などの多数のターゲット フォーマットへ変換します。
– また、生成された CHM ヘルプ ファイルを開発中のアプリケーションと統合するために、C++、Delphi、Fortran、Pascal、および Visual Basic プログラミング言語用のコードを生成する機能も備えています。
– バージョン 4 の HelpNDoc には、ドキュメントのレイアウトを追跡し、統計を提供し、リンク切れやメディア項目の問題などの潜在的な問題を特定できるプロジェクト アナライザーが付属します。
- HelpNDoc は、ナビゲーション メニューとしての目次、ナビゲーション ボタン付きのトピック内容、キーワード索引メニュー、内蔵検索エンジン、モバイル固有のユーザー インターフェイス要素を使ってモバイル ウェブサイトの発行にも使用することができます。
https://www.helpndoc.com/
#2 ClickHelp
様々な機能を持つドキュメントツールをお求めの場合は、クリックヘルプは最適なものでしょう。 ClickHelp は、セットアップと使用が簡単な、最新のブラウザーベースのドキュメント ツールです。
世界中のソフトウェア会社がクリックヘルプを使用して、オンライン ユーザー マニュアル、ナレッジ ベース、ヘルプ ファイル、FAQ、チュートリアルを作成し、自社のポータルで即座に公開しています。
特徴
-毎日のバックアップ- ClickHelp は毎日のバックアップを提供するので、データが安全であることを確認できます
-高度な分析- ClickHelp には独自の統合分析があるので、現在の状況を分析し、ドキュメントのプロセスを前もって計画するのに役に立ちます。
-人間が読めるプロジェクトの URL- 人だけでなく、検索エンジンにも有用な機能で、この機能はドキュメントの SEO に役立ちます。
– ソーシャルメディア共有ボタン- さまざまなソーシャルメディアでドキュメントを簡単に共有できます。 クリックヘルプは、レビューノート機能だけでなく、特別なレビュアーの役割も提供します。
強力なトピックエディター-すべてのテクニカルライターは、優れたテキストエディタを好みます。
このアプリケーションでは、さまざまな機能を使用できます。
https://clickhelp.com/
#3 Whatfix
あなたのプラットフォームでインタラクティブガイドを作ってみたいですか？ Whatfix は、企業がアプリケーション・ユーザーをオンボードし、トレーニングし、サポートするためのデジタル・アドプション・プラットフォームです。
Whatfixは、フロー、ヘルプのヒント、ビデオ、リンク、テキストなどのフォームを使用して、文脈に応じてカスタマイズしたコンテンツを作成し、アプリ内の体験として提供することが可能です。
さらに、Whatfixはクラウドとセルフホスティングの両方の導入モードをサポートしています。
特徴
-マルチブラウザ互換API
– インタラクティブ ユーザーガイド
-セルフホスティング
– データ分析
– ユーザー追跡
ビデオ、グラフィック、イメージ、テキストなど複数のガイド形式があります。
-カスタマイズ可能なユーザーインターフェース
#4 ProcessStreet
ProcessStreetは、チームのために繰り返し行われるワークフローを管理する最も簡単な方法です。 また、チェックリストのワークフローをチームにすばやく割り当てることができます。
ProcessStreet はシンプルなインターフェイスで、構造化されたドキュメントを数秒で作成することができます。 さらに、ダッシュボードからアクティビティを追跡することができ、タスクが完了すると通知されます。
チームのプロセスドキュメントのホームであり、直感的なキーボードショートカットとドラッグ＆ドロップにより、誰でも簡単に使用することができます。
機能一覧
-条件付きロジック-条件付きロジックを使用して、チームの変化するニーズに適応する if/then ロジックで真に動的なチェックリストを作成します。 データを手動で入力するか、選択したアプリケーションとの間でデータを送信することができます。
-ルールベースのワークフロー
-コラボレーション ワークスペース
In conclusion
技術文書作成の種類によって利用できるソフトウェアツールはいろいろありますが、ターゲットユーザーによって選ぶものが異なります。 一度始めたら、どれが自分にとって理想的かいつでも決めることができます！
最も魅力的なものの感触をつかむ必要があります。