Update 2025/5/6
Apr 2025 The Symbol Syndicate’s Docs Blogs
2025年4月のブログはこちらから
【日本語訳】
月日が経つのはあっという間ですね。4月はひたすら雑務に追われてヘトヘトでした。
行った作業の概要
- コンテンツ執筆 想定通り、4月は主に3冊の本の冒頭部分の執筆に費やしました。冒頭部分はその後のすべてのページの雛形となる、極めて重要な部分です。したがって、問題点があれば早期に発見できるよう、時間をかけて慎重に取り組んでおりました。 何点かを以下にお示しします:
- ユーザーマニュアル: task-docs-user 並びやスクリーンショットの見せ方はいかがでしょうか？画像をクリックすると、説明を表示したまま全画面表示に切り替わる工夫がしてあります。さらに、全画面表示の状態でも左右のキー操作で手順を一つずつ確認できるようになっております！
- 開発者向けマニュアル:task-docs-dev このマニュアルでは、複数の言語によるコードスニペット（短いコード例）を掲載しており、各メソッドやエンドポイントのドキュメントへのリンクを提供しています。これらのリンクには、マウスオーバー時に短い説明やヒントがポップアップ表示されるツールチップ機能を実装しています（ただし、現時点ではすべての言語で完全に機能しているわけではありません）。 さらに、将来的にチュートリアルをより分かりやすくするための、いくつかの内部的な改善も進めております。
- テキストブック:task-docs-textbook テキストブック（教科書）はとかく退屈に感じられがちですので、読者は通常、必要とする特定のテーマのみを参照し、その後は離れてしまう傾向があります。そこで、重要な点を囲み枠で表示するようにしました。さらに、用語にリンクを設定し、カーソルを重ねると、要約がポップアップ表示されるように工夫しております。ぜひお試しください！
- サイトの構成 インフラの大部分は既に構築されており、必要に応じてテンプレートの作成時に機能を追加して対応しました。プラグインで対応できた場合もあれば、Python、Jinja、HTMLなどを使う場合もありました。
- マネジメント 4月はあまりマネジメント業務に時間を費やすことなく終えることができました🎉
タスクリストの管理をし、ミーティング用のプレゼン資料を準備し、AIアシスタントのchadGPTと少し仲良くなる時間も取りました。
今月のタスクごとの時間配分はこちらでご確認いただけます。
ドキュメンテーションの状況
毎月作業の進捗状況を更新する予定です。注目していただきたいところは一番上の「Symbol Documentation」で、他の項目はそのサブタスクとしてリストされています。チャートの棒グラフは、完了したサブタスクの数を表しています。
次の作業
テンプレートは完成しました！これによりコンテンツページの作成に必要な土台が整いましたので、速やかに作業を開始し、順調に進められる見込みです。
並行して、インフラ関連の作業も進めてまいります。具体的には、一部リンクで機能していないツールチップ機能の修正、SDKの進捗に合わせたJavaドキュメントの追加、選択された言語に応じたメソッドリンクの調整などを予定しております。
3月の月報で、Daruma Studiosについて紹介しましたが(英語原文を読む/日本語訳を読む) 、残念ながら今月は取り組む時間がありませんでした。ですが試してみたいアイデアが次々と浮かんでいますので、ぜひ楽しみにしていてください！
最後までお読みいただき、本当にありがとうございました！
—