テクニカルライティング・ポートフォリオ
これは、私のテクニカルライティング・ポートフォリオの中でも、ソフトウェア関連のサンプルに特化したポートフォリオです。Docusaurusを使用し、すべてMarkdownで執筆・公開されたソフトウェアドキュメントのサンプルを包括的に紹介しています。ここでは、開発者ガイド、APIリファレンス、およびそれらを作成するために使用されたワークフローに関する洞察をご覧いただけます。
注記
機密保持契約（NDA）のため、私の仕事のほとんどを共有することはできませんが、このポートフォリオには、私のテクニカルライティングのスキルとプロセスを示すオリジナルのコンテンツが含まれています。
ポートフォリオのナビゲーション
ガイド
- Google Chromeへのテーマのインストールと適用
- Postmanを使用したStripe APIへの接続
- Writageを使用したMicrosoft WordからGitHub Wikiへのワークフロー
- クラウドアプリケーションログのパイプラインへのルーティング
- チュートリアル：オブジェクトデータの取得
- チュートリアル：トランザクションの送信
APIリファレンス
- Stripe APIドキュメント
- Pet Store APIドキュメント
- ストリーミングAPI経由でのイベント取り込み
- SuiClient: getObject
- SuiClient: multiGetObjects
- SuiClient: getOwnedObjects
概念・概要ドキュメント
これらのドキュメントの生のMarkdownファイルを表示するには、**GitHub**にアクセスしてください。
ドキュメントのワークフロー
- VS CodeでのMarkdownによるドラフト作成
- ValeによるMarkdownのリンティング
- DeepLによる翻訳
- Mermaidによるダイアグラム作成
- Gitによるドキュメントのバージョニング
- PostmanおよびSwagger/OpenAPIによるAPI検証
- Docusaurusによる公開
テクニカルスタック
- Docusaurus: 静的サイトおよびドキュメントの生成用。
- VS Code: すべてのコンテンツのプライマリエディタ。
- Postman: APIテストおよびAPIドキュメントサンプルの生成用。
- Vale: リンティングおよびスタイルガイドの遵守確認用。
- Git/GitHub: バージョン管理およびホスティング用。
- Mermaid Chart: Mermaidコードの画像への変換。
- DeepL MCP: ドキュメントの多言語翻訳用。
これは、Docusaurusや同様の静的サイトジェネレーターなどの開発者ドキュメントポータルをプロフェッショナルなチームがどのように維持しているかを反映しています。
各作品は、リサーチ → ドラフト作成 → レビュー → 公開という、エンドツーエンドのドキュメント作成プロセスを示しています。