annai（ソースコードからマニュアルを自動生成するツール）マニュアルについて
annai は、ソースコードからユーザーマニュアルを自動生成するツールです。 このマニュアルでは、annai の導入から日常的な使い方までをご案内します。
このサービスでできること
- ソースコードからマニュアルを自動生成 — プロジェクトのソースコードを読み取り、ユーザー向けのマニュアルページを自動で作成します
- 変更箇所だけをすばやく更新 — ソースコードに変更があった部分のマニュアルだけを再生成します。毎回すべてを作 り直す必要はありません
- 品質を自動でチェック — 生成されたページの文体やわかりやすさを自動で採点し、基準に満たないページは自動で書き直します
- ワンコマンドで公開 — 生成したマニュアルをそのままインターネット上に公開できます
- ソースコードが更新されるたびに自動で反映 — 自動更新の仕組みを設定すると、ソースコードを変更するたびにマニュアルも最新の状態に保たれます
こんな方におすすめです
- マニュアル作成に時間をかけられない開発チーム — ソースコードを書いたら、マニュアルは annai にお任せできます
- マニュアルを常に最新の状態に保ちたい方 — ソースコードの変更に合わせて、マニュアルも自動で更新されます
- はじめてマニュアル作成ツールを導入する方 — コマンドを1つ実行するだけで、すぐに使い始められます
このマニュアルの使い方
このマニュアルは、目的に合わせて3つのセクションに分かれています。
- はじめ に — annai を導入する手順を説明しています。初めて annai を使う方は、まずこのセクションをお読みになることをおすすめします
- 使い方 — マニュアルの生成、更新、公開といった日常的な操作を説明しています。必要な機能のページを選んでお読みになれます
- トラブルシューティング（問題の原因と解決方法）・よくある質問 — 困ったときの対処法をまとめています
各ページの冒頭に「このページでできること」が書かれています。 目的のページかどうかをすぐに判断できます。
はじめに読む
annai を使い始めるには、まず初期設定を行います。 以下のページから始めましょう。
- プロジェクトを初期設定する — 設定ファイルを作成し、マニュアル生成の準備を整えます
- マニュアルを一括生成する — ソースコードを解析して、マニュアルを一括で生成します
- マニュアルを公開する — 生成したマニュアルをインターネット上に公開します
注意
annai を使うには、あらかじめ Claude（対話型 AI アシスタント）がお使いのコンピュータにインストールされている必要があります。 インストール方法は プロジェクトを初期設定する で説明しています。