AURRA
← Return to Portfolio
HEATING 72 °F SET · 74°F HUMID 42% ECO AURRA · AI CLIMATE
Independent Documentation Project · 2025–Present
Smart Thermostat Platform

AURRA is an AI-powered smart thermostat platform built as a documentation vehicle — a technically realistic IoT product designed specifically to demonstrate API reference documentation, developer integration writing, SDK documentation, and consumer-facing UX writing in a single cohesive suite.

REST API OAuth 2.0 SDK · Webhooks Predictive HVAC Python · JavaScript
View Documentation Suite →
4
Doc Artifacts
12+
API Endpoints
4
Audience Types

Documentation built to prove what words can't.

Several engagements in this portfolio — particularly NYC OCME — produced technical documentation that cannot be publicly shared under NDA. AURRA was built to close that gap: a self-directed project with a technically realistic product, designed from scratch to exercise the full range of technical documentation disciplines.

The product scenario is intentionally demanding: an IoT thermostat platform with a REST API, OAuth 2.0 authentication, predictive HVAC diagnostics, webhook infrastructure, and multi-platform SDK integration. Every documentation challenge present in enterprise work — API taxonomy, developer onboarding, end-user cognitive load — is represented.

All four artifacts are original. No source material was adapted or transcribed. The structural decisions, information architecture, and content strategy choices reflect the same methodology applied across Domino's, Google, and DoorDash engagements.

📡
API Reference Documentation
Full endpoint taxonomy, parameter schemas, error handling, and multi-language code samples for a 12-endpoint REST API.
⚙️
Developer Experience (DX) Writing
OAuth 2.0 integration, webhook setup, and SDK quickstart written for engineers integrating at the platform level.
UX Writing — Consumer Docs
End-user guide applying plain language, progressive disclosure, and task-oriented structure for a non-technical audience.
🏗️
Information Architecture
Endpoint grouping, navigation taxonomy, and content model decisions that scale across a technically dense reference document.
🔬
ML Model Transparency Documentation
Model card following Google Model Card Toolkit format: architecture, training data, SHAP feature importance, threshold calibration, subgroup performance, limitations, and ethical considerations.

Four artifacts. Four audiences.

Each document targets a distinct reader — API consumers, integration engineers, end users, and ML stakeholders — demonstrating the ability to calibrate register, structure, and information density across the full documentation spectrum.

A.01 · API Reference
📡
AURRA API Reference Guide
Audience — API Consumers · Backend Engineers

Complete endpoint documentation for the AURRA REST API. Covers authentication, thermostat control, predictive diagnostics, and voice assistant integration — each endpoint with parameter schemas, example requests, response shapes, and Python + JavaScript code samples.

REST API OAuth 2.0 Endpoint Taxonomy Code Samples
A.02 · Integration Guide
⚙️
Developer Integration Handout
Audience — Developers · Integration Engineers

A developer-facing guide covering the full AURRA integration lifecycle — authentication setup, telemetry endpoints, predictive maintenance configuration, webhook registration, and SDK quickstart. Code-first, task-oriented, minimal friction.

SDK Docs Webhooks DX Writing Quickstart
A.03 · User Guide
Smart Thermostat User Guide
Audience — Consumers · Non-Technical Users

Consumer-facing documentation for the AURRA platform. Covers device setup, scheduling, eco mode, predictive alerts, and app integration — applying plain language, progressive disclosure, and task sequencing calibrated to non-technical cognitive load.

UX Writing Consumer Docs Plain Language Task-Oriented
A.04 · Model Card
🔬
Predictive Maintenance Model Card
Audience — ML Engineers · Product Managers · Compliance

Transparency documentation for the ML model powering AURRA's predictive HVAC maintenance. Covers model architecture, training data composition, SHAP feature importance, threshold calibration with cost-sensitive analysis, subgroup performance, limitations, and ethical considerations.

Model Card XGBoost ML Transparency AI Governance