package-docs

Community

Guide to writing perfect package READMEs.

AuthorSatanaCSharp
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps maintainers write and standardize README documentation for shared packages inside the AniMemoria monorepo, ensuring consistent structure and frontmatter across all packages.

Core Features & Use Cases

  • Canonical template guidance for NestJS-style packages and variants when needed.
  • Step-by-step guidance to inspect package.json, analyze exports, and review existing docs for accurate documentation.
  • Use cases include documenting exports, usage examples, environment requirements, and contribution notes for any package under packages/.

Quick Start

Create and place a README.md for each package under packages/ using the canonical package-docs template described here.

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: package-docs
Download link: https://github.com/SatanaCSharp/animemoria/archive/main.zip#package-docs

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.