技术写作作品集
技术写作作品集
本站收录技术写作作品集中的软件文档示例。Docusaurus 从 Markdown 与 MDX 源文件生成每个页面。内容涵盖开发者指南、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 读取查询的教程。
- 使用写入操作发送交易。指导签署并广播可编程交易的开发者指南。
Sweepy 职位搜索文档
Sweepy 是一个开源 Python 工具,它查询申请人跟踪系统与职位板,然后将每条职位与简历比对并排序。这套 13 页的文档涵盖安装、配置文件设置、PDF 与 CSV 报告,以及可从 AI 助手运行扫描的 Model Context Protocol (MCP) 服务器。
入门
- 认识 Sweepy。说明扫描的流程、五个管道阶段,以及 Sweepy 如何为简历评分。
- 安装 Sweepy。讲解 Windows、macOS 和 Linux 上的 Python、Git 与仓库设置。
- 运行第一次扫描。演示如何创建配置文件、启动扫描并读取进度输出。
阅读结果
- 理解结果。拆解 PDF 卡片结构、匹配度、申请徽标和 CSV 跟踪列。
- 简历与匹配度。讲解解析器所需的简历格式,以及从简历到匹配度的评分路径。
- 通过 MCP 从 AI 助手运行 Sweepy。将内置 MCP 服务器连接到 Antigravity、Claude Desktop 或 VS Code。
Sweepy 文档索引汇总各类参考页面。内容涵盖命令、配置项、开发者说明和工具参考,并列出支持的职位来源与平台。
API 参考文档
- Stripe API 文档。面向金融科技与支付基础设施的 API 参考文档。
- Pet Store API 文档。遵循 OpenAPI 3.0 规范的模块化 REST API 参考。
- Datadog 日志采集 API。用于批量提交遥测数据的流式 API 参考。
- Sui TypeScript SDK 参考:
架构与概念文档
- Stripe API 简介。金融基础设施、核心实体与身份验证的概念性概述。
- Pet Store API 简介。Swagger/OpenAPI Petstore REST 服务与认证方案概述。
- 事件流与可观测性管道。流处理、边缘路由与数据转换的架构概述。
- 开始之前 - 面向云和 AI 的并行可观测性。对比企业系统日志路由模型的架构指南。
- SuiClient。说明分布式 RPC 客户端如何路由状态查询。
提交信息与拉取请求
- NumPy F 顺序数组修复。解决数组内存布局问题的开源拉取请求描述与提交信息。
- 在 JAX 中对 ak.mean 进行自动微分。阐明 Awkward Array 自动微分支持的文档与提交信息。
案例研究
- 设计 Artie,AI 文档助手。分析提示词工程、OWASP LLM 安全性与 RAG 检索架构的工程案例研究。
这些文档的原始 Markdown 源码可在 GitHub 仓库 中查看。
文档即代码(Docs-as-code)工作流
- 使用 VS Code 和 Antigravity 进行 Markdown 与 MDX 编写
- 使用 Vale 进行文本风格与语法静态检查
- 使用 DeepL 和 Lara 进行国际化与本地化翻译
- 使用 Mermaid 绘制系统架构图
- 与随附代码同步编写命令行工具及其 MCP 服务器的产品文档
- 使用 Git 和 GitHub 进行版本控制与协作代码评审
- 使用 Postman 与 Swagger/OpenAPI 进行 API 调试与验证
- 使用 Docusaurus 进行持续部署
技术栈
- Docusaurus。生成静态站点、侧边栏导航以及本地化多语言版本。
- VS Code。提供 Markdown 与 MDX 编写的主要编辑环境。
- Postman。验证 API 端点并生成请求与响应示例。
- Vale。静态检查技术文本,确保符合 Google 开发者文档风格指南。
- Git 和 GitHub。管理分支版本控制与网站部署。
- Mermaid。渲染流程图与数据管道图。
- Python 与 MCP。运行 Sweepy 扫描引擎及连接 AI 助手的工具服务器。
- DeepL 和 Lara。自动将文档翻译成其他语言。
每个页面在同一仓库中都有对应的 Markdown 或 MDX 文件。可将渲染结果与生成它的文本对照查看。
每个示例都经过同一条流程,从调研和撰写,到用真实输出测试,再到评审与发布。