56.9K Views
June 17, 23
スライド概要
40代のテクニカルアーティスト2年目 / Unreal認定インストラクターのポジTAの「ドキュメントの書き方」と「なんで書いているか」について書きました
コピーしてペッする ポジTA式 UEドキュメント術
Index はじめに 1
ポジTA(ポジティーエー、ポジタ) 40代のテクニカルアーティスト2年目 Web Unreal認定インストラクター :https://posita.blog/ Twitter : @posita33 Zenn : https://zenn.dev/posita33?tab=books https://zenn.dev/creek_coyote?tab=books 2
UnrealEngineの本をZennで書いてます 有料だけど無料で読めます 毎週1ページずつ無料で読めます 3
目次 1. なぜドキュメントを書くのか? a. 「UnrealEngieを一緒に開発できる人が増えると嬉しい」の意味 b. なぜドキュメントを書くのか 2. 誰に向けて書くのか a. ペルソナを設定する b. 職種別ドキュメント 3. ポジTA式 UEドキュメント術 a. 目次・見出しを書く(プラトー(学習停滞期)を乗り越える) b. どうやって書くか(Screenpresso術) c. 文章校正・フィードバッグ(嘘・間違いは信用を失う) i. インシデント(ヒヤリハット)対策(気を付けていること) d. 概要を書く(何が得られるページなのか) 4. まとめ 5. 参照URL 4
なぜ? 誰に? どうやって? なぜ? 誰に? どうやって? 5
1 なぜドキュメントを書くのか
1.a Unreal Engineを一緒に開発できる人が増えると嬉しい
UnrealEngineを一緒に開発できる人が増えると嬉しい 8
金沢の友禅染の社長から教わった4分類 自ら燃える人 一緒に燃える仲間 状況次第で燃える人 絶対燃えない人 9
4分類の比率 10
お金・技術の権限が持っている人が何を使うか決める 権限持っている この技術を使いましょう 11
状況次第で燃える人たちは困っている → Negative 12
困っていることを解決する → Poisitive 13
なぜ基本無料で公開しているか 権限持っている 権限ない クレカない 教育は余剰資金で行われる (最後の方) 14
UEを一緒に開発できる人が増えると嬉しい 一緒に開発できる人 15
1.b なぜドキュメントを書くのか
困っていることを解決する → Poisitive 17
1番困っているのは自分(自分の分身が他人N) 1 共感・共有 N 18
信用貯金(必ず助けてくれる仲間が現れる) 協力・資金提供・信頼(ファン) 信用貯金 1 共感・共有 N 19
重要なのは「誰が」書いている情報か 一方通行 共感・共有 20
「断絶への航海」(これからのAI時代をどう生きるか) 完全にAIに育てられた人たちが育った星「ケイロン」に 地球から資本主義の人たちが植民地にしようと星を訪れる話 ・仕事をしなくてもいい世界で人は何で仕事をするのか ・バイアスが効いていない世界で職種がどう決まるのか ・完全に無料の世界で独り占めするとどうなるのか これからのAI時代について考えさせられる作品 21
/(スラッシュ)ワークの時代(Like / Life) 会社員 / フリーランス (Like/Life) Light Work Life Work ポジTA (UnrealEngieを一緒に開発できる人が増えると嬉しい) Unreal認定インストラクター (UnrealEngine人材育成の問題を解決する) Like Work テクニカルアーティスト (UnrealEngineプロダクトの問題を解決する) Rice Work 会社員・アルバイト (生活するために働く) 【人生の4つのステージ、ライスワークからライトワークへ】 https://note.com/b110ef567/n/n975f3e3d0347 22
2 誰に向けて書くのか
2.a ペルソナを設定する
ポジTAは誰をターゲットとしているか 一緒に開発できる人 25
困っていることを解決する → Poisitive 26
「UE5 C++ & Blueprint」の場合 【ターゲット】 将来決定権を持てる可能性がある ゲーム業界のUnrealEngineプログラマ <抱えている問題> 就職・転職でUE C++を必要としている Blueprint⇔C++の情報が無くて困っている C++の情報を書くのは怖い <スキルレベル> オブジェクト指向言語を1言語でも学習中・学習済み UEのBlueprintを触ったことがある <情報収集> Web、Twitter、YouTube、Qiita、Zenn <趣味> ゲーム(FPS)・Webマンガ・アニメ・Web小説 27
「ポジTAMA!」の場合 【ターゲット】 ゲーム業界のUEプロジェクトで 教育担当になる講師・先輩エンジニア 学校で時間が余ってしまう優秀な学生(TA候補) <抱えている問題> UEを何処から教える・学習すればいいか分からない 準備・学習コストが高い 遊ばせて・遊んでしまう時間が発生する <スキルレベル> BlueprintでUEを触ったことがある <情報収集> Web、Twitter、YouTube、Qiita、Zenn、Udemy <趣味> ゲーム・マンガ・アニメ・映画・旅行 28
ペルソナ設定で届けたい人に情報を届ける 共感・共有 ペルソナマーケティングとは?メリットや設定方法を解説 https://www.cross-m.co.jp/column/marketing/util112/ 29
2.b 職種別ドキュメント
職種別ドキュメント 画像・動画 アーティスト (リーダー) アーティスト テクニカルアーティスト ロジック 企画 (企画書) 企画 (仕様書) エモーション エンジニア 文章 31
職種別ドキュメント 画像・動画 結論から アーティスト (リーダー) 文章を図解する 分かりやすいビジュアル アーティスト モチベが上がる 図で説明する 分かりやすい例で テクニカルアーティスト ロジック 企画 (企画書) 企画 (仕様書) エモーション 結論から書く 過不足なく エンジニア 文章は短文で短く 文章 32
職種別ドキュメント 画像・動画 アーティスト (リーダー) アーティスト テクニカルアーティスト ロジック ノードベース(Blueprint)や YouTubeの影響 企画 (企画書) エンジニア 企画 (仕様書) エモーション エンジニア 文章 33
職種別ドキュメント 画像・動画 アーティスト (リーダー) ロジック ノードベース(Blueprint)や YouTubeの影響 結論から書く 過不足なく テクニカルアーティスト 文章は短文で短く 文章を図解する エンジニア 企画 分かりやすい例で (仕様書) アーティスト 企画 (企画書) エモーション エンジニア 文章 34
3 ポジTA式 UEドキュメント術
ポジTA式 UEドキュメント術(ワークフロー) 目次、見出し どうやって 書くか 文章校正 フィードバッグ 要約 本・プレゼン ツールの力を借りる (Textlint) スクショ・GIF ・動画 このページでは 何を知れるか (SGE対策) 絶対途中と分かるように汚 くする (Todo・駄目出し) 記事・手順書 1. タイトル a. 見出し2 i. 見出し3 b. 見出し2 i. 見出し3 動画 36
3.a 目次・見出しを書く (プラトー(学習停滞期)を乗り越える)
目次を作成してゴール設定する(本・プレゼン) だいたい こんなもの 多くなっちゃった コースは迷路だけど ゴールは見えるマラソン 2023/2/17 2023/5/8 38
目次をカード(タスク)に分解する(カンバン方式) 39
見出しを作成して一気に書ききる(記事・手順書) 1. タイトル a. 見出し2 i. 見出し3 b. 見出し2 i. 見出し3 誘惑を断ち切る短距離走 振り切る 見出しは3まで (4まで許す) 後で書こう 今日はここまで 40
短距離走を繰り返す迷路マラソン「GRIT」 コースは迷路だけど ゴールは見える 短距離走マラソン 印象 GRID 現実 Guts(ガッツ):困難に立ち向かう「闘志」 Resilience(レジリエンス):失敗してもあきらめずに続ける「粘り強さ」 Initiative(イニシアチブ):自らが目標を定め取り組む「自発」 Tenacity(テナシティ):最後までやり遂げる「執念」 「GRIT(やりぬく力)」~困難にも屈せず長期的な目標達成に向けて全力を尽くす~ https://posita.blog/article/engine/2022/08/grit/ 41
プラトー(学習停滞期)を乗り越える 常にマラソンの意識は捨てない (燃え尽きない) プラトー(学習停滞期)を乗り越えろ!乗り越えるための10個のチャレンジ https://note.com/posi_ta/n/n52e597742084 42
3.b どうやって書くか (ScreenPresso術)
Screenpresso 44
職種別ドキュメント 画像・動画 アーティスト (リーダー) ロジック ノードベース(Blueprint)や YouTubeの影響 結論から書く 過不足なく テクニカルアーティスト 文章は短文で短く 文章を図解する エンジニア 企画 分かりやすい例で (仕様書) アーティスト 企画 (企画書) エモーション エンジニア 文章 45
文字を読まなくても画像で操作できるドキュメント 46
視線を誘導する5要素+動画 色 (明度) フォーカス (矩形) 番号は使わない (めんどい) ベクトル (矢印) アイコン (操作) 文字 (入力) 動画 47
1.色(黄色を多用している理由) 48
白黒にした時 49
黄色は白の次に明るい(有彩色以外で1番明るい) 黄色は明度が1番明るい(ハッキリ見える) 50
明度の差が大きいところに視点は集まる 画面が白い時は 紺色(青)を使用する 51
色覚障害は男性の20人に1人 特に赤と緑が分からない人が多い それは赤色?緑色?~「色覚障害」への理解を求めて https://www.nhk.or.jp/heart-net/article/547/ 52
2.矩形(何処を操作するのかフォーカスを当てる) 53
矩形にフォーカスが移動する 54
3.ベクトル(操作の順番を方向づける) 55
3.ベクトル(操作の順番を方向づける) 1 2 56
4.操作アイコン(操作手順が分かる) 57
操作手順が分かる 1 1 2 3 2 58
貼り付けた方が早い 59
5.文字(文字を読ませないで画像で完結する) 60
画像にアセット名を書いてしまえば画像で操作できる 61
文字の下に半透明の座布団を敷く 文字が多い場所に文字を置くと 目立たなくなってしまう より文字にフォーカスがあたるように 他の文字の明度が低くなる座布団を敷く 62
トンマナ(Tone & Manner)を整える 文章は「~します。」(丁寧語) 画像のTextは「~する」(ですます調) 画像は文字数を少なくする ・折り返しを無くせる ・極力大きくできる ・1文字でも修正を少なくできる 文章は読む人に向けてなので丁寧に書く 技術文章なので1文を短く 「トーン(tone:調子や色調)&マナー(manner:様式や作風)」 (ポジTAのドキュメントと一瞬で分かると負荷が軽減される) トンマナの意味とは?デザイン・文言のルール設定方法・事例を解説! https://pantograph.co.jp/blog/uiux/tone-manner.html 63
番号を振らなくても視線誘導で順番が追える 6 1 2 3 4 5 64
視線誘導の連続で画像のみで進められる 65
視線誘導は動画が圧倒的に強い Anime GIF・動画 動画 66
手順は画像・動作は動画 Anime GIF・動画 作成に時間がかからない 手順を追いやすい 動画 作成に時間がかかる 動作を確認しやすい 67
現時点で最高峰のドキュメント Using Niagara for Linear Content https://dev.epicgames.com/community/learning/tutorials/PdDR/unreal-engine-fortnite-using-niagara-for-linear-content 68
3.c 文章校正・フィードバック (嘘・間違いは信用を失う)
重要なのは「誰が」書いている情報か 一方通行 共感・共有 70
嘘はすぐバレてしまう(監視社会) 共有 71
記事は強者にチェックされている(マイナス評価) もっといい手順がある 誤字がある 文章がおかしい 手順通りやっても できない 共感・共有 おっちょこちょい 72
解決できることは対策する もっといい手順がある 誤字がある 文章がおかしい 手順通りやっても できない 共感・共有 おっちょこちょい 対策 73
対策方法 もっといい手順がある 味方にする空気づくり 誤字がある 文章がおかしい 手順通りやっても できない 文章校正 (Textlint) フィードバック 共感・共有 おっちょこちょい 74
対策:もっといい手順がある(味方にする空気づくり) もっといい手順がある ありがとうございます! 強者は 根はいい人 (実践する) よくなりました! ありがとうございます! 75
対策:誤字がある・文章がおかしい 誤字がある 文章がおかしい 冗長な文章 サービス名の表記ミス 文章校正 (Textlint) 信用度の低下を 防止する 信用度の高い文章を書く人 という評価 76
対策:手順通りできない(フィードバック) 手順通りやってもできない 嘘ではないけど嘘になるケース 自分でDebugしてもらえる 環境を提供する 77
味方の強者は気付かないミスや要望を教えてくれる GitHubにissueを書いてくれる 手順の誤りを教えてくれる 78
レビューする立場の時: 絶対直さないといけない状態にして返す 絶対直さないといけない資料として返す ツールのコメント機能を使わない 79
後から直すときはTODOを残す(Todo Tree) TODO検索できるVS Code拡張「Todo tree」 忘れないうちにTODOを残そう https://zenn.dev/posita33/articles/vscode_extension_todo_tree 80
記事の最後に参照したURLを書く 嘘ではないけど嘘になるケース 参考にしたURLを書いておかないと パクリ認定されてしまうケースがある 何かを参考にしたら引用元を書いておく 引用・Webサイトの参考URLの正しい書き方を解説|プレゼン資料の「 参考文献リスト」作成時の注意点も紹介 https://u-note.me/note/47488449 引用と参考文献の書き方 https://www.clib.kindai.ac.jp/search/pdf/guide_quote.pdf 81
3.c’ インシデント(ヒヤリハット)対策 (気を付けていること)
嘘はすぐバレてしまう(監視社会) 共有 83
善意の行動もインシデント(ヒヤリハット)で台無しに 共有 インシデント 【incident】 https://e-words.jp/w/%E3%82%A4%E3%83%B3%E3%82%B7%E3%83%87%E3%83%B3%E3%83%88.html 84
関係のないフォルダパスは塗りつぶす パス情報には個人名・案件名といった重要な情報が 入っている場合があるので塗りつぶす ログ情報にはパス情報が多く含まれているので プロジェクト名までのパスを塗りつぶす 85
エクスプローラの左側は折りたたむ エクスプローラの左側にもフォルダ名が表示されている ので折りたたむ プロジェクトのフォルダ構成が分かるのは許容している 86
Projectの配布はFile -> Zip Projectから ProjectフォルダをエクスプローラからZipファイルにすると Developersフォルダが含まれてUser名が分かってしまう File -> Zip ProjectからProjectをZip化すれば、 Developersフォルダを含まない 87
AssetにDeveloper名が入る場合もある MetaSoundのAssetを作成すると AuthorにDeveloper名が入っています 執筆用のUserやPCを分けておくのが安全 88
Webブラウザのブックマークバーは整理する トップはフォルダだけにする 常に見られても大丈夫な状態に整理する 89
3.d 要約 (何が得られるページなのか)
技術記事の閲覧行動は数行の情報で決定される 91
要約を書いてから手順を書く 章としての何ができるのか 概要を書いてからページを書く 1ページで何ができるのか 概要を書いてから手順を書く 92
滞在時間が増える・検索上位になる 共感・共有 93
検索はSEOからSGEへ SEO(Search Engine Optization) SGE(Search Generative Experience) AIの解答の下に記事が表示される 筆者が実践しているか(SNSも含む経験が重視) 専門家の監修がついているのか 実践している? プロフィールは? 専門家? Googleのアプデで従来のSEO技術は通用しなくなる(AIの影響) https://www.youtube.com/watch?v=wTmRw4nPhis Google検索に生成AIを導入 文脈で探索できる「SGE」 https://webtan.impress.co.jp/n/2023/05/19/44886 94
Google Birdに聞いてみた 共感・共有 95
3 まとめ
なぜ書くのか (困っていることを解決する → Poisitive) 97
UnrealEngineを一緒に開発できる人が増えると嬉しい 一緒に開発できる人 98
「誰が」書いている情報かが重要になってきている 一方通行 共感・共有 99
ペルソナ設定で届けたい人に情報を届ける 共感・共有 100
どの職種に向けて書くのか 画像・動画 アーティスト (リーダー) ロジック ノードベース(Blueprint)や YouTubeの影響 結論から書く 過不足なく テクニカルアーティスト 文章は短文で短く 文章を図解する エンジニア 企画 分かりやすい例で (仕様書) アーティスト 企画 (企画書) エモーション エンジニア 文章 101
ポジTA式 UEドキュメント術(ワークフロー) 目次、見出し どうやって 書くか 文章校正 フィードバッグ 要約 本・プレゼン ツールの力を借りる (Textlint) スクショ・GIF ・動画 このページでは 何を知れるか (SGE対策) 絶対途中と分かるように汚 くする (Todo・駄目出し) 記事・手順書 1. タイトル a. 見出し2 i. 見出し3 b. 見出し2 i. 見出し3 動画 102
AIも含めた共感してくれる仲間を作る 共感・共有 103
6 参照URL
1. なぜドキュメントを書くのか 【人生の4つのステージ、ライスワークからライトワークへ】 https://note.com/b110ef567/n/n975f3e3d0347(参照 2023-06-09) 「スラッシュ」ワークについて 日経テレ東大学・高橋弘樹P「ズルい働き方」で叶えたいこと https://www.youtube.com/watch?v=TTD75TY2TK0(参照 2023-06-12) 105
2. 誰に向けて書くのか ペルソナマーケティングとは?メリットや設定方法を解説 https://www.cross-m.co.jp/column/marketing/util112/(参照 2023-06-12) 106
3. ポジTA式 UEドキュメント術(メンタル) 「GRIT(やりぬく力)」~困難にも屈せず長期的な目標達成に向けて全力を尽くす~ https://posita.blog/article/engine/2022/08/grit/(参照 2023-06-09) プラトー(学習停滞期)を乗り越えろ!乗り越えるための10個のチャレンジ https://note.com/posi_ta/n/n52e597742084(参照 2023-06-09) 107
3. ポジTA式 UEドキュメント術(色) それは赤色?緑色?~「色覚障害」への理解を求めて https://www.nhk.or.jp/heart-net/article/547/(参照 2023-06-09) Accessible Design with Unreal Engine https://dev.epicgames.com/community/learning/courses/7M1/accessible-designwith-unreal-engine/yGwl/accessible-design-in-unreal-engine-overview (参照 2023-06-13) 108
3. ポジTA式 UEドキュメント術(書く技術) ポジTAのZenn設定 https://zenn.dev/posita33/articles/zenn_github_and_vscode_setup (参照 2023-06-09) 紹介したVSCodeのExtensionも紹介しています。 - Todo Tree - テキスト校正くん Using Niagara for Linear Content(現時点で最高のドキュメント) https://dev.epicgames.com/community/learning/tutorials/PdDR/unreal-enginefortnite-using-niagara-for-linear-content(参照 2023-06-09) トンマナの意味とは?デザイン・文言のルール設定方法・事例を解説! https://pantograph.co.jp/blog/uiux/tone-manner.html(参照 2023-06-13) 109
3. ポジTA式 UEドキュメント術(引用) 引用・Webサイトの参考URLの正しい書き方を解説|プレゼン資料の「参考文献リ スト」作成時の注意点も紹介 https://u-note.me/note/47488449(参照 2023-06-13) 引用と参考文献の書き方 https://www.clib.kindai.ac.jp/search/pdf/guide_quote.pdf(参照 2023-06-13) 110
3. インシデント(ヒヤリハット) インシデント 【incident】 https://ewords.jp/w/%E3%82%A4%E3%83%B3%E3%82%B7%E3%83%87%E3%83%B3% E3%83%88.html(参照 2023-06-09) 111
3. SGEについて Googleのアプデで従来のSEO技術は通用しなくなる(AIの影響) https://www.youtube.com/watch?v=wTmRw4nPhis(参照 2023-06-09) Google検索に生成AIを導入 文脈で探索できる「SGE」 https://webtan.impress.co.jp/n/2023/05/19/44886(参照 2023-06-09) 112
C++ & Blueprintシリーズ(3部作) 設計する (2024-25) 実践する 有料だけど無料で読めます 始める:https://zenn.dev/posita33/books/ue5_starter_cpp_and_bp_001 動かす:https://zenn.dev/posita33/books/ue5_starter_cpp_and_bp_002 113
ポジティブなTAを育む教材マガジン「ポジTAMA!」 3年間続ければ 専門学校1年分x3 毎週1ページずつ無料で読めます Vol000 : https://zenn.dev/creek_coyote/books/positama_vol000 Vol001 : https://zenn.dev/creek_coyote/books/positama_vol001 114
Unreal認定インストラクターについて UNREAL 認定インストラクター プログラム ガイド https://cdn2.unrealengine.com/unreal-authorized-instructor-program-guide-v2-ja-529c8f6973af.pdf 【教える経験+作れる経験が必要】 ・インストラクターとしての経験が一年以上必要で、 それをLinkedinの自身のページに記載する必要があります。 ・授業のサンプル動画(Udemy,YouTube)を必要とします。 応募はこちらから https://www.unrealengine.com/ja/authorized-instructor-apply 115
勉強や開発を一緒に楽しんでいきましょう! 116