K
エンドユーザー向けマニュアルを自動生成・更新
by knagamatsu
コードベースを分析して、研究者や化学者などのエンドユーザー向けの「難しくないマニュアル」を自動生成できます。技術用語をできるだけ避け、画面操作の手順を明確に説明します。 インストール手順、クイックスタート、UI操作ガイド、トラブルシューティング、FAQ など、ユーザーが実際に困る内容を網羅したマニュアルを生成するため、サポート対応の負担を減らせます。 UI変更、機能追加があると、自動的にマニュアル更新を提案してくれるので、ドキュメントの陳腐化を防げます。 スクリーンショットが無い段階ではプレースホルダーを使い、後で実画像に置き換えられるようにしておくので、マニュアル作成と実装が並行進行しやすくなります。 アプリケーション開発者で、ユーザーマニュアルも一緒に作りたい人 技術的でないユーザーでも分かるドキュメントを効率的に作成したい UI変更のたびにマニュアルを手作業で更新するのが負担な人 研究ツール、化学系ソフトなど、専門分野のエンドユーザー向けドキュメントが必要な開発者 このスキルはエンドユーザー向けマニュアル(USER_GUIDE.md)を生成・更新します。目的は技術的でない言葉でシステムを説明し、UI操作手順を明確化し、トラブルシューティング情報を提供することです。実行タイミングは「ユーザーマニュアル更新」「マニュアル生成」「ユーザーガイド作成」などのリクエストで自動適用されます。マニュアル構成は「はじめに」(目的・機能・対象ユーザー)、「インストール」(環境・手順)、「クイックスタート」(5分で実行する方法)、「UI操作ガイド」(画面ごとの説明)が含まれ、各セクションは研究者・化学者が理解しやすい表現で書かれています。
テストドキュメント