Introduction

Welcome to my technical writing portfolio

This site collects the software documentation samples from my Technical writing portfolio. Docusaurus builds every page from Markdown and MDX source. The set covers developer guides, API references, product documentation, and the workflow behind each sample.

Portfolio navigation

Browse the samples by deliverable type and domain:

Developer and system guides

• Installing and Applying a Theme to Google Chrome. A step-by-step browser customization walkthrough featuring interactive UI tabs and responsive layout.
• Microsoft Word to GitHub Wiki Workflow with Writage. A guide to writing Markdown in Word, then committing wiki revisions with GitHub Desktop.
• Using Postman to Connect to the Stripe API. A guide for authenticating and making API requests in Postman.
• Create a Postman Mock Server. A practical tutorial for configuring mock servers to test webhook integrations and API schemas.
• Route cloud app logs into a pipeline. An operational procedure for ingesting and filtering cloud app telemetry.
• How to Fetch Object Data. A tutorial explaining RPC read queries with the Sui TypeScript SDK.
• Using Write Operation to Send a Transaction. A developer guide for signing and broadcasting programmable transactions.

Sweepy job search documentation

Sweepy queries applicant tracking systems and job boards, then ranks each posting against a resume. This Python tool is open source and includes a 13-page documentation set. It covers installation, profile setup, and PDF or CSV exports. It also documents a Model Context Protocol (MCP) server that runs sweeps from an AI assistant.

Get started

• Meet Sweepy. Explains what a sweep does, the five pipeline stages, and how Sweepy scores a resume.
• Installing Sweepy. Walks through Python, Git, and repository setup on Windows, macOS, and Linux.
• Running your first sweep. Follows a first sweep from profile creation to the progress readout.

Read the results

• Understanding your results. Breaks down PDF card anatomy, match percentages, application badges, and CSV tracking columns.
• Resumes and match scores. Covers resume formatting for the parser and the scoring path from resume to match percentage.
• Sweepy MCP integration. Connects the built-in MCP server to Antigravity, Claude Desktop, or VS Code.

The Sweepy documentation index collects the reference pages. It covers commands, configuration keys, developer notes, and the tool reference. It also lists the supported job sources and platforms.

API references

• Stripe API Documentation. API reference docs for fintech and payment infrastructure.
  • Balance APIs
  • Payment Intent APIs
  • Refund APIs
• Pet Store API Documentation. A modular REST API reference that follows the OpenAPI 3.0 specification.
  • Pets APIs
  • Store APIs
  • User APIs
• Datadog Log Ingestion API. Streaming API reference for submitting batch telemetry data.
• Sui TypeScript SDK reference:
  • SuiClient.getObject
  • SuiClient.multiGetObjects
  • SuiClient.getOwnedObjects

Architecture and conceptual documentation

• Introduction to the Stripe API. Conceptual overview of financial infrastructure, core entities, and authentication.
• Introduction to the Pet Store API. Overview of the Swagger/OpenAPI Petstore REST service and authentication schemes.
• Event Streams and Observability Pipelines. Architectural overview of stream processing, edge routing, and data transformation.
• Parallel observability for cloud and AI. Architectural guide comparing log routing models for enterprise systems.
• The SuiClient. Explains how distributed RPC clients route state queries.

Commit messages and pull requests

• NumPy F-ordered array fix. A pull request description and commit message from an open source project that resolve array memory layout issues.
• Differentiating through an ak.mean in JAX. Documentation and commit message explaining automatic differentiation support in Awkward Array.

Case studies

• Designing Artie, an AI documentation assistant. An engineering case study analyzing prompt engineering, OWASP LLM security, and RAG retrieval architecture.

To inspect the raw Markdown sources for these documents, browse the GitHub repository.

Docs-as-code workflow

• Authoring in Markdown and MDX using VS Code and Antigravity
• Prose and style guide linting with Vale
• Internationalization and translation with DeepL and Lara
• System architecture diagramming with Mermaid
• Writing product documentation for a command-line tool and its MCP server as part of each release
• Version control and collaborative code review with Git and GitHub
• API exploration and validation with Postman and Swagger/OpenAPI
• Continuous deployment with Docusaurus

Technical stack

• Docusaurus. Generates static sites, navigation sidebars, and localized versions.
• VS Code. Provides the primary editing surface for Markdown and MDX authoring.
• Postman. Validates API endpoints and generates request/response examples.
• Vale. Lints technical prose to enforce Google Developer Documentation guidelines.
• Git and GitHub. Manages branch version control and site deployment.
• Mermaid. Renders flowcharts and data pipeline diagrams.
• Python and MCP. Run the Sweepy sweep engine and the tool server that connects it to AI assistants.
• DeepL and Lara. Automate documentation translation into other languages.

Each page has a Markdown or MDX file in the same repository. Compare the rendered output with the text that produced it.

Every sample follows the same path from research and drafting to testing against real output, review, and publishing.