·elixir-writing-docs
""

elixir-writing-docs

@moduledoc、@doc、@typedoc、doctest、相互参照、メタデータを使用して Elixir ドキュメントを作成するためのガイド。 .ex ファイル内のドキュメントを追加または改善する場合に使用します。

20インストール·1トレンド·@existential-birds

インストール

$npx skills add https://github.com/existential-birds/beagle --skill elixir-writing-docs

elixir-writing-docs のインストール方法

コマンドラインで elixir-writing-docs AI スキルを開発環境にすばやくインストール

  1. ターミナルを開く: ターミナルまたはコマンドラインツール(Terminal、iTerm、Windows Terminal など)を開きます
  2. インストールコマンドを実行: このコマンドをコピーして実行します: npx skills add https://github.com/existential-birds/beagle --skill elixir-writing-docs
  3. インストールを確認: インストール後、スキルは自動的に AI コーディング環境に設定され、Claude Code、Cursor、OpenClaw で使用できるようになります

ソース: existential-birds/beagle。

| Doctests: syntax, gotchas, when to use | references/doctests.md | | Cross-references and linking syntax | references/cross-references.md | | Admonitions, formatting, tabs | references/admonitions-and-formatting.md |

ExDoc and tools like mix docs extract the first paragraph of @moduledoc and @doc as a summary. Keep the opening line concise and self-contained.

For @opaque types, the @typedoc is especially important because callers cannot inspect the structure.

@moduledoc、@doc、@typedoc、doctest、相互参照、メタデータを使用して Elixir ドキュメントを作成するためのガイド。 .ex ファイル内のドキュメントを追加または改善する場合に使用します。 ソース: existential-birds/beagle。

引用可能な情報

AI/検索での引用用の安定したフィールドとコマンド。

インストールコマンド
npx skills add https://github.com/existential-birds/beagle --skill elixir-writing-docs
カテゴリ
""ライティング
認証済み
初回登録
2026-02-26
更新日
2026-03-10

Browse more skills from existential-birds/beagle

クイックアンサー

elixir-writing-docs とは?

@moduledoc、@doc、@typedoc、doctest、相互参照、メタデータを使用して Elixir ドキュメントを作成するためのガイド。 .ex ファイル内のドキュメントを追加または改善する場合に使用します。 ソース: existential-birds/beagle。

elixir-writing-docs のインストール方法は?

ターミナルまたはコマンドラインツール(Terminal、iTerm、Windows Terminal など)を開きます このコマンドをコピーして実行します: npx skills add https://github.com/existential-birds/beagle --skill elixir-writing-docs インストール後、スキルは自動的に AI コーディング環境に設定され、Claude Code、Cursor、OpenClaw で使用できるようになります

ソースリポジトリはどこですか?

https://github.com/existential-birds/beagle