api-doc-authoring

Community

Automates API docs with a 3-layer structure.

Authorw5851
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This guide provides a structured approach to documenting APIs for Julia_RelaxTime by enforcing a three-layer view (user-facing entry, responsibilities core, and the complete exported API) and ensuring the export index is generated by scripts rather than manually updated.

Core Features & Use Cases

  • Enforces a three-layer documentation layout: user entry points, core responsibilities, and a complete exported API set.
  • Requires the exported API surface to be auto-generated by scripts, avoiding manual maintenance.
  • Supports governance rules for stable entry points, module boundaries, and automated checks to improve consistency and collaboration.

Quick Start

Follow the API doc authoring guidelines and run the repository scripts to regenerate the export index and verify coverage.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: api-doc-authoring
Download link: https://github.com/w5851/Julia_RelaxTime/archive/main.zip#api-doc-authoring

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.