Showcase

Writing & Documentation Samples

Explore interactive samples of API references, CLI usage guides, and troubleshooting documentation.

Showcase Overview

These samples demonstrate my ability to structure, format, and present complex developer resources using Docs-as-Code principles. The content covers end-to-end documentation patterns for a connected vehicle ecosystem.

Documentation Stack

Technologies I use to design, build, and maintain scalable documentation systems:

Category Tools & Technologies
Docs-as-Code & Developer Tooling Eleventy, MkDocs (static sites), Markdown, Git (version control)
Structured Authoring & Publishing DITA XML, MadCap Flare, Oxygen XML Author
API & Developer Documentation REST API documentation, JSON, CLI-based workflows
Collaboration & Workflow JIRA, Confluence, Agile Methodologies

Key Writing Skills Demonstrated

  • Structural modulatory: Creating clear, step-by-step procedures.
  • Command-line clarity: Mapping options, argument dependencies, and outputs.
  • API parameter mapping: Displaying path and query parameters with matching request/response models.
  • Actionable troubleshooting: Creating symptom-to-cause mappings to reduce support times.

Select a sample from the sidebar to view the technical content.

About this Sample

Goal: Onboard developers to a connected vehicle ecosystem.

Key Skills: Hardware-software prerequisites, CLI installation, and API-driven telemetry access.

Getting Started (Connected EV Platform)

Welcome to the developer portal. This guide will help you connect your local environment to your scooter’s onboard computer (Dashboard) to start pulling telemetry data.

The Command Line Interface (CLI) acts as a bridge between your local machine and the Smart Vehicle Platform API.

CLI → API Layer → Vehicle Cloud → Scooter

  • The CLI sends requests to the Smart Vehicle Platform API.
  • The API retrieves data from the vehicle cloud.
  • The scooter streams telemetry back to your application.

Prerequisites

Before you begin, ensure you have the following:

  • Hardware: Ather Gen 3 vehicle with an active Connect Pro subscription.
  • Software: Node.js v18.0 or higher.

1. Install the CLI

The CLI is the primary tool for interacting with the platform. Install it globally using npm:

npm install -g @ather/rizta-cli

2. Authenticate your scooter

To securely access your vehicle data, you must pair your scooter using its VIN (Vehicle Identification Number).

  1. Run the following command in your terminal: 
    rizta auth --pair
  2. When prompted for your "Riding Profile," select your preferred mode:
    • Eco: Max range, minimum API polling.
    • Zip: Balanced performance.
    • Warp: High-frequency data streaming.

3. Make your first API call

Verify your setup by retrieving battery and range information.

Example Request

rizta status --vehicle-id "rizta_001"

Example Response

{
"vehicle": "Rizta_Z_Limited",
"location": "Mumbai_West",
"soc": 88,
"range_km": 112,
"status": "ready",
"easter_egg": "bike_of_scooters"
}

About this Sample

Goal: Provide a command-level reference for interacting with the platform CLI.

Key Skills: CLI documentation structure, command syntax design, parameter clarity, and mapping CLI actions to API behavior.

CLI Command Reference

The command-line interface allows developers to interact with the Smart Vehicle Platform directly from the terminal.

Command Structure

rizta <command> [options]

Global Options

Option Description
--help Displays help for a command
--version Shows CLI version
--output json Formats output as JSON

Pair a vehicle

rizta auth --pair

Pairs your local CLI with a scooter using VIN-based authentication.

Options

Option Required Description
--vin Yes Vehicle Identification Number
--profile No Riding profile (eco, zip, warp)

Example

rizta auth --pair --vin "RIZTA123456" --profile warp

Get vehicle status

rizta status --vehicle-id <id>

Retrieves real-time vehicle telemetry including battery, range, and operational state.

Example

rizta status --vehicle-id "rizta_001"

Response

{
"soc": 88,
"range_km": 112,
"status": "ready"
}

About this Sample

Context: Demonstrates documentation for a RESTful resource.

Key Skills: Structured parameter tables, JSON syntax highlighting, and standard HTTP error mapping.

REST API Reference

Base URL: https://api.smartvehicle.com/v1

All requests require authentication using a Bearer token in the request header:

Authorization: Bearer <access_token>

Get Product Details

GET /v1/products/{product_id}

Retrieves metadata for a specific inventory item, including real-time stock levels across warehouse locations.

Path Parameters

Parameter Type Required Description
product_id string Yes The unique identifier of the product.

Query Parameters

Parameter Type Default Description
include_location boolean false If true, returns a breakdown of stock by warehouse ID.

200 OK Response Example

{
"id": "rizta_pwr_unit",
"sku": "ATHR-GEN3-MUM",
"name": "PMSM Traction Motor Cog",
"total_stock": 350,
"status": "warp_mode_active",
"last_updated": "2026-03-28T10:00:00Z"
}

About this Sample

Goal: Help developers quickly diagnose and resolve common setup issues.

Key Skills: Error-driven documentation, actionable resolutions, and mapping failures to system components.

Diagnostic Troubleshooting Guide

Identify and resolve common issues when connecting to and interacting with your vehicle telemetry systems.

Common Issues

Issue Possible Cause Resolution
CLI command not found CLI not installed or not in PATH Reinstall using npm install -g @ather/rizta-cli and restart terminal.
Authentication fails (authentication_failed) Expired or invalid session Re-run authentication sequence: rizta auth --pair.
Vehicle not found (vehicle_not_found) Incorrect vehicle ID or VIN not paired Verify vehicle registration values and ensure active pairing.
Rate limit exceeded (rate_limited) Too many requests in short time Reduce polling request frequency in your application.