やぁ皆さん！3ヶ月連続で、都度最後のSymbolドキュメントレポートになるって約束してきましたけど……今回こそ本当に最後だと思います。
Symbol のドキュメント作成は正式に完了しました。
(リリース予定のプロダクトのユーザーガイドについては現在保留中ですが、倫理的にも私の良心的にも、後日追記をします。)
それでは、Symbol のドキュメントに関する最終レポートと NEM ドキュメントに関する新シリーズのレポートの始まり、そして……ゲーム開発モードへの復帰をお届けします。
行った作業の概要
コンテンツ執筆 Jaguar が新しいSymbolドキュメントサイトを徹底的にレビューした際に付けたコメントに対して、丸一ヶ月かけて目を通しました。
技術的な問題を指摘するコメントもあれば（これについては私のミスです！）、書き方に焦点を当てたもの、改善のための提案も多くありました。それらはかなりの数にのぼりました。
レビューには予想以上の時間を要してしまいましたが、結果ドキュメントの質は大幅に向上し、ようやく公式 Symbol ドキュメントとして公開できる状態になりました。
一例としては、開発者マニュアルのランディングページでは、チュートリアルが難易度別に分類されるようになったため、適切な出発点を初心者が見つけやすくなりました。
レビュー 開発者ページ(task-docs-dev) Zero が新しい NEM ドキュメントサイトの作業を開始しており、私は届いたものから順次レビューを行っています。現在進行中の作業は、こちらから確認できます。
このサイトは新しい Symbol ドキュメントと同じ構成になっており、ユーザーマニュアル、開発者マニュアル、そしてそれらを補完するテキストブックで構成されています。テキストブックはすでに完成しており、現在はチュートリアルの作成に作業が移行しています。
Symbol SDKは Symbol と NEM の両方のブロックチェーンをサポートしているため、ほとんどの NEM チュートリアルは Symbol のものと非常に類似しているため、作業は迅速に進むと予想しています。 🤞🏻
DARUMA STUDIO 5月は時間をなんとか融通できたので、 XYM City のゲームデザインドキュメントの作業に 丸2日間 を充てることができました。
Symbol のドキュメントレビューがようやく終わったので、今後数ヶ月でその数字が大幅に伸びることを期待しています... 💃🏻
サイト構成 ⚙️ Jaguarのレビューコメントのいくつかは、サイトの基盤となるインフラに大幅な変更を必要とするものでした。
終わったはずのものをリファクタリングする作業は、格別の苦痛を伴います。ですが、痛みは一時的でもGitは永遠に残る。そう自分に言い聞かせて作業を続けました。チュートリアルシステムには現在以下のものがあります:
- 各チュートリアルにラベルを付与し、開発者マニュアルのランディングページ上でソート済みの表を自動生成するための複雑性メタデータタグ。
- 行番号ベースの参照ではなく名前付きコードスニペットを採用することで、スニペットの範囲を絶えず更新することなくソースコードを進化させることが可能になります。
- チュートリアルテキスト内の変数名が、選択したプログラミング言語に合わせて自動的に適応されるようになりました。メソッド名やクラス名は以前からこのようになっていましたが、変数は対応していませんでした。
学習 🤖 Hatchetは、最新のAI支援ワークフローを習得するよう私たちに推奨しています。
以前からChatGPTを駆使して自分の文章を推敲していましたが（すみません！英語は母国語ではないのです）、今月からは一歩進んで、VS CodeにCodexを導入しました。
サイトのリファクタリング作業中、それが非常に役に立つことが分かりました。ドキュメントリポジトリ全体の構造を理解できるアシスタントがいるというのは、明らかに利点です。
とは言え、まだかなり厳しく管理しています。少し被害妄想気味かもしれませんが、私の確認なしに何かをコミットさせるつもりはありません。
こちらが今月の各タスクの相対的な時間配分です：
ドキュメンテーションの進捗状況
Symbol Symbolのドキュメントは正式に完成しました。残る作業は、最終的なURLで公開するためのサイト準備のみです。
もちろん、ドキュメントが完全に完成することはありません。新しいプロダクトや機能が開発されるにつれて、新しいガイドが追加されていくことになります。
これが最後の進捗チャートの投稿になります……この美しい100%のバーを見てください。 🥲
NEM 次回からは代わりに NEM のドキュメントについて報告していきます。 このセクションを簡略化することにしました。読者の方にはより見やすく、私のためには… 上の図を作成するのに予想以上に時間がかかるからです😅
状況シンプルに見てとれます。計画されているNEMドキュメント作成タスクのうち、25%がすでに完了しているか、もしくは進行中です。
次の予定
NEMのドキュメントに関する Zero の作業のレビューの継続
ついに報われました。ようやく XYM City の設計に戻れます
私の子供のような XYM City としばらく離れすぎていて寂しい！
キャラクター設定やミッションデザイン、台本を除いても、ゲームデザインドキュメントがもう40ページ近くありますと言っても、皆さん信じられますか？
これからはその仕事についても報告していきますが、あまりネタバレしすぎないように気をつけます。 🙂
ここまでお読みいただきありがとうございました。また来月お会いしましょう！
