fusion-package-scribe

Official

Automate TypeScript package docs and READMEs

Authorequinor
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Many TypeScript monorepos have inconsistent or missing TSDoc comments and READMEs, which makes APIs hard to discover, reuse, and surface in retrieval/semantic search. This Skill systematically finds public exports, generates or improves TSDoc for exports, and rewrites package READMEs to a consistent, retrieval-friendly structure so maintainers can onboard and use packages faster.

Core Features & Use Cases

  • Monorepo and single-package passes: discover packages and barrel exports, then apply documentation improvements either across the workspace or to a specific package.
  • TSDoc generation and improvement: add meaningful summary lines, @param/@returns/@example tags, and avoid name-echo/type-echo anti-patterns while preserving valuable existing docs.
  • README standardization and review council: rewrite READMEs to a template optimized for discoverability and run an automated review step before committing documentation-only changes.

Quick Start

Run a single-package documentation pass for the package at packages/utils/observable to generate or improve TSDoc and rewrite its README, committing documentation-only changes per package.

Dependency Matrix

Required Modules

None required

Components

referencesassets

💻 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: fusion-package-scribe
Download link: https://github.com/equinor/fusion-skills/archive/main.zip#fusion-package-scribe

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.