テクニカルライティング・ポートフォリオ

これは、私のテクニカルライティング・ポートフォリオのうち、ソフトウェア関連のサンプルに特化したポートフォリオです。Docusaurusを使用して、すべてMarkdown形式で作成・公開されたソフトウェアドキュメントのサンプルを網羅的に紹介しています。ここでは、開発者向けガイドやAPIリファレンスの例、およびそれらを作成するためのワークフローに関する洞察をご覧いただけます。

ポートフォリオのナビゲーション

成果物の種類とドメインごとに整理されたドキュメントサンプルをご覧ください：

開発者およびシステムガイド

• Google Chromeへのテーマのインストールと適用。インタラクティブなUIタブとレスポンシブなレイアウトを備えた、段階的なブラウザカスタマイズ手順書です。
• Writageを使用したMicrosoft WordからGitHub Wikiへのワークフロー。WordでMarkdownを記述し、GitHub DesktopでWikiをクローンして変更を公開するためのガイドです。
• Postmanを使用したStripe APIへの接続。Postmanでの認証とAPIリクエスト実行のためのガイドです。
• Postmanモックサーバーの作成。Webhook統合とAPIスキーマをテストするためのモックサーバー構築チュートリアルです。
• クラウドアプリのログをパイプラインにルーティングする。クラウドアプリのテレメトリを取り込んでフィルタリングするための運用手順書です。
• オブジェクトデータの取得方法。Sui TypeScript SDKによるRPC読み取りクエリを解説するチュートリアルです。
• 書き込み操作を使用したトランザクション送信。プログラマブルトランザクションの署名とブロードキャストを解説する開発者ガイドです。

APIリファレンス

• Stripe API ドキュメント。フィンテックおよび決済インフラストラクチャ向けのAPIリファレンスです。
  • 残高 API
  • Payment Intent API
  • 払い戻し API
• Pet Store API ドキュメント。OpenAPI 3.0仕様に準拠したモジュール型REST APIリファレンスです。
  • ペット API
  • ストア API
  • ユーザー API
• Datadogログ取り込みAPI。バッチテレメトリデータを送信するためのストリーミングAPIリファレンスです。
• Sui TypeScript SDKリファレンス：
  • SuiClient.getObject
  • SuiClient.multiGetObjects
  • SuiClient.getOwnedObjects

アーキテクチャおよび概念ドキュメント

• Stripe API 入門。金融インフラ、主要エンティティ、認証の概念的な概要です。
• Pet Store API 入門。Swagger/OpenAPIによるPetstore RESTサービスと認証スキームの概要です。
• イベントストリームとオブザーバビリティパイプライン。ストリーム処理、エッジルーティング、データ変換のアーキテクチャ概要です。
• オブザーバビリティパイプラインを始める前に。エンタープライズシステム向けのログルーティングパラダイムを比較するアーキテクチャガイドです。
• SuiClient アーキテクチャ。分散RPCクライアントがどのように状態クエリを編成するかを説明するメンタルモデルです。

コミットメッセージおよびプルリクエスト

• NumPyのF順序配列の修正。配列のメモリレイアウトの問題を解決するオープンソースのプルリクエスト説明とコミットメッセージです。
• JAXにおけるak.meanの微分。Awkward Arrayにおける自動微分サポートを解説するドキュメントとコミットメッセージです。

ケーススタディ

• Ask Artie AIアシスタントのケーススタディ。プロンプトエンジニアリング、OWASP LLMセキュリティ、RAG検索アーキテクチャを分析するエンジニアリングケーススタディです。

これらのドキュメントの未加工のMarkdownソースを確認するには、**GitHubリポジトリ**をご覧ください。

Docs-as-code ワークフロー

• VS CodeとAntigravityを使用したMarkdownおよびMDXの執筆
• Valeによる文章およびスタイルガイドの静的検証
• DeepLおよびLaraによる国際化と翻訳
• Mermaidによるシステムアーキテクチャ図の作成
• GitとGitHubによるバージョン管理と共同コードレビュー
• PostmanとSwagger/OpenAPIによるAPI検証
• Docusaurusによる継続的デプロイ

技術スタック

• Docusaurus。静的サイト、ナビゲーションサイドバー、ローカライズ版を生成します。
• VS Code。MarkdownおよびMDX執筆のメインエディタとして機能します。
• Postman。APIエンドポイントを検証し、リクエスト・レスポンスの例を生成します。
• Vale。Google Developer Documentationガイドラインに準拠するよう技術的文章を検証します。
• Git・GitHub。ブランチのバージョン管理とサイトのデプロイを管理します。
• Mermaid。フローチャートやデータパイプラインのアーキテクチャ図を描画します。
• DeepLおよびLara。ドキュメントの多言語翻訳を自動化します。

この環境は、現代のエンジニアリング企業における本番開発者ポータルを忠実に再現しています。

各サンプルは、調査・執筆・テスト・レビュー・公開に至るエンドツーエンドのドキュメント制作プロセスを反映しています。