レシピ投稿画面を開く
レシピ投稿は「マイレシピ一覧」の画面からすることができます。(画面右上の「人型アイ コン」→「マイレシピ一覧」) 画面右上の「マイレシピを作成する」をクリックすることでレシピ投稿の作成画面に遷移す ることができます。
レシピの構造を知る レシピは下記のような構造となっており、執筆する部分についてはマークダウン記法で入力するフォーマットになっています。 <レシピの構造>
決められたフォーマットの「##」(H2タグ)の下部に、テキストを入力していくことでレシピを 作成することができます。
<Markdown記法で入力する部分のフォーマット>
メニュー*
概要*
学べること*
始める前のスキルセット*
実務活用例*
キッチン*
開発環境*
ツール*
データセット
調理*
手順1(変更可能)
手順2(変更可能)
手順3(変更可能)
※注意
- 「*」印は任意を表しており、削除することはできません。
- 手順の括弧箇所には手順名を記載きます。
(例)
手順1(変更可能) ⇒ ## 〇〇のインストール
手順2(変更可能) ⇒ ## 〇〇の実行
良いレシピを作るためには
普段エンジニアとして活躍されている方でも、執筆の豊富経験が無い方が大半かと思います。いざ、自身の経験やノウハウをレシピにするとしても、どのような考え方を持って執筆すればよいか分からない事が大いにあります。 ここでは良いレシピを作るために心がけるポイントを紹介します。
-
魅力的なタイトルや内容であること
ありふれたものではなく、唯一無二の内容が望ましいです。たとえ一見ありふれたテーマであっても、自身の考え方を付け加えたり、他の要素を掛け合わせることで、魅力のある内容になります。
-
最初の手順において、環境設定やデータ用意等の事前準備に関する内容が設けられていること
- 学習者の多くは事前準備で躓き、挫折をしています。少々手間がかかる箇所ではありますが、しっかり明記するようにしましょう。
-
単なる読み物にならないように、コーディング等の手を動かす作業が含まれていること
- とにかく動かしてみることが、学習者にとって大切だと考えており、そうすることで理解を促進させることができます。
-
コードに適切なコメントを入れてあること
- 説明不足のコードは学習者からすると、理解ができないまま進めてしまうことに繋がります。適切にコメントを入れましょう。
-
経験に基づく考え方やノウハウは多く盛り込むこと
- 多くのユーザーは現役エンジニアのノウハウを求めて言います。自身の培ったものを存分に広めましょう。
-
学習者がレシピを通して正しく学習出来たことを確認できること
- 例えばプログラムの実行結果を明記すること等がこれにあたります。正しい学習ができたか分からないという事は、学習者が自身を持てなかったり、また誤った理解をしてしまうリスクがあります。
-
手順の最後は「まとめ」で締めくくりましょう○ 要点を整理したり、学習者に向けたアドバイスを行いましょう。
「タイトル」を入力する
まずは、レシピのタイトルを決めます。「●●●●レシピ」と最後にレシピという文言をつけるようにしましょう。投稿するまではいつでも修正可能なため、思いつかない場合は仮のタイトルを入れておきましょう。 (例:画像認識によるパンの種類を分類するレシピ)
「下書き保存」をする
画面右上の「下書き保存」ボタンで現在の入力データを保存をすることができます。入力中のデータ消失を防ぐため、こまめに保存をしましょう。
「全体プレビュー」を閲覧する
一度でも「下書き保存」を行うと、「全体プレビューを閲覧する」ボタンがアクティブになります。押すと実際の学習画面のプレビューを表示することができます。このあと様々な項目を入力していきますので、適宜「下書き保存」ボタンを押して最新の入力データを保存しつつ、全体プレビューで内容チェックをしながら進めていきましょう。
「メニュー」を入力する
レシピの「メニュー」に該当する「概要」、「学べること」、「始める前のスキルセット」、「実務活用例」をMarkdown記法で入力していきます。このレシピを学習することで、学習者は何ができるようになるのか伝えるための重要な部分となります。「概要」以外は箇条書き で記載することが望ましいです。レシピは有料と無料のものがありますが、有料でも購入前にユーザーが閲覧することができます。ユーザーはこの部分を見てレシピ全体の流れや学習する必要性を判断することができます。
※画像や動画ファイルの挿入はコピー&ペースト、もしくは下部の画像挿入アイコンから可能。容量は32Mまでとなります。
「キッチン」を入力する
レシピの「キッチン」に該当する「開発環境」、「ツール」、「データセット」をMarkdown記法で入力していきます。 このレシピに含まれるコードが実行できる環境等を明示します。これらには出来る限りバージョン情報も記載してください。データセットはオープンソースであれば内容や参照先を、また学習者が用意する必要があればその事が分かるようにしましょう。これらは全て、箇条書きで記載することが望ましいです。レシピは有料と無料のものがありますが、有料でも購入前にユーザーが閲覧することができます。
※画像挿入はコピー&ペースト、もしくは下部の画像挿入アイコンから可能。
「調理」を入力する
レシピの「調理」に該当する「手順」をMarkdown記法で入力していきます。レシピのメイン 部分となります。「手順」は 「## 〇〇」と記載することで、章や節のような単位に区切って 学習の進捗ポイントを設けるようになっています。
「手順」の2つめまでは予め記載されているので任意の手順名に上書きしていきましょう。 3つめ以降は「## 〇〇〇」の形式で手動で追加をしていくことが可能です。
(例)
調理*
〇〇のインストール
まず初めに、〇〇をインストールしましょう。 インストールするには・・・
〇〇の実行
手順1でインストールした〇〇を実行していきましょう。 正常にインストールされていることを確認するために・・・
デモデータでの出力結果確認
デモデータを用いて、実際にどのように結果が出力されるのか見てみましょう。 この後、実際のデータを使った場合のやり方も・・・
左ウィンドウで入力したテキストは、右ウィンドウにプレビュー表示されるので、markdown で正しく入力できているか確認しながら進める事が可能です。
※画像挿入はコピー&ペースト、もしくは下部の画像挿入アイコンから可能。
「アイキャッチ」を設定する
レシピが検索されたときに、直感的に学習者にレシピが伝わるようにアイキャッチ画像を 設定しましょう。設定した画像は下図のように、主に「レシピ検索」時に使用され、探しや すくなる、学習者の興味を持たせる効果があります。
「タグ」を設定する
レシピのなかで重要なワードをタグ(先頭”#”が自動で付きます)として設定しましょう。例 えば「#画像分類」「#形態素解析」等の大まかなソリューション名や、 「# Ubuntu」「# Docker」など環境に関わるもの、また「#Python」「PyTorch」のように言語名やライブラリ名でも問題ありません。最大で10個まで可能ですが、関係の薄いワードは タグ設定をしないようにしましょう。
「価格」を設定する
レシピを購入する価格を設定します。0円の場合は、無料レシピとなります。 有料レシピにする場合、ユーザーは調理の部分は購入しない限り閲覧することができま せん。記載された価格にてレシピを購入すると初めて、レシピの調理部分を閲覧できるよ うになります。購入されたレシピの価格の30%は、レシピ投稿者へ還元いたします。
投稿する際に、チャプタータイトル末尾に “:free”をつけることで、有料レシピでも調理の 中の:free付与のチャプターの内容を、購入前に無料で閲覧できるようになります。
レシピ内容で、コード部分や自身のノウハウ部分を有料にし、開発までの導入部分を無 料で公開するなど、自由にチャプターの見せ方を変更いただけます。
ユーザー画面
「テスト」を作成する
学習者が正しく学習したかどうかの確認テストを作成します。 問題方式は「4択形式の 正解選択」であり、設問は「1問以上」作成する必要があります。それぞれ「問題」と「選択 肢」を入力し、正解となる「回答」がどの「選択肢」になるか設定をしてください。また、2問 以上の設問を作成する場合は、「設問を追加する」を選択し、作成してください。
テストは運営側で作成することもできますので、その場合は空にしてください。
レシピを公開依頼する
全ての項目の入力が完了しましたら、最後に「公開依頼」を行います。「下書き保存」ボタ ンの「三角」部分をクリックすると「公開依頼」が表示され選択することができます。「公開 依頼」をクリックすることで、運営側にレシピ公開を依頼することができます。なるべく「公 開依頼」前にはプレビューで全体内容を確認するようにしましょう。 正常に「公開依頼」が完了した場合は、自動的に「マイレシピ一覧」に遷移します。これで Axross事務局へ公開依頼を行った状態になります。公開依頼したレシピは、Axross事務 局にて内容確認を行ったうえで2週間以内に通知いたします。公開依頼が承認されます ると、「レシピ検索」の画面に表示されるようになり、他のユーザーからも見えるようになり ます。これで、レシピ投稿から公開までの一連の手順が完了となります。
<選択画面>
<公開依頼ボタン>
<「マイレシピ一覧」へ遷移後、公開依頼の状態>
