技术写作作品集

这是一个专门展示我技术写作作品集中软件相关示例的作品集。它全面展示了软件文档示例，所有内容均使用 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
  • 支付意向 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 开发者文档风格指南。
• Git 和 GitHub。管理分支版本控制与网站部署。
• Mermaid。渲染流程图与数据管道架构图。
• DeepL 和 Lara。自动化多语言文档翻译。

该环境真实还原了现代工程团队在生产环境中维护开发者门户的流程。

每个范例均体现完整的端到端文档创作流程：调研、撰写、测试、评审与发布。