docs

Write and improve markdown documentation for the AI Transport SDK.

5|Updated Mar 24, 2026
One-click install
npx skills add https://github.com/ably/ably-ai-transport-js --skill docs-ably
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/ably/ably-ai-transport-js/tree/main/.claude/skills/docs
Command: npx skills add https://github.com/ably/ably-ai-transport-js --skill docs-ably

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you write, revise, and review markdown documentation for the AI Transport SDK so the docs stay accurate, consistent, and easy to use.

Core Features & Use Cases

  • Document creation and revision: Draft new pages or improve existing ones for features, concepts, references, and internals.
  • Docs quality control: Apply the project's structure, voice, terminology, and cross-reference rules to keep pages consistent.
  • Example use case: Use this Skill when adding a new SDK feature so the documentation explains the problem, shows the recommended path first, and links to related pages without inventing unsupported behavior.

Quick Start

Ask for a markdown doc rewrite that follows the AI Transport SDK style guide and keeps the page focused on one developer intent.

Frequently Asked Questions about docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write markdown documentation for an SDK feature page?

To write markdown documentation for an SDK feature page, draft the content by adhering to the project's voice, structure, and terminology. Ensure the page explains the problem, shows the recommended path first, and maintains code-verified accuracy without inventing unsupported behavior.

What is the best way to keep technical writing consistent across reference docs?

The best way to keep technical writing consistent across reference docs is to apply the project's specific structure, voice, and cross-reference rules during the review process. This ensures all pages remain aligned and easy for developers to use.

How do I revise existing AI Transport SDK docs for a new feature?

You revise existing AI Transport SDK docs by requesting a markdown rewrite that follows the project style guide. This process focuses the page on a single developer intent while updating features, concepts, or internals with accurate cross-references.

Does this docs review process support concept and internals pages?

Yes, the docs review process supports concept and internals pages. It applies strict terminology and structure rules to feature pages, concept pages, reference pages, quickstarts, and internals docs to keep the SDK documentation accurate and consistent.

When should I not use an automated markdown doc generator?

You should not use an automated markdown doc generator when a feature requires strict code-verified accuracy and specific cross-reference rules. Inventing unsupported behavior or ignoring the project's voice will degrade the quality of SDK reference and internals documentation.