skills.rest
SatanaCSharp
SatanaCSharpCOMMUNITY
Explore all skills by this author →
GitHub

package-docs

Generate README documentation for packages using canonical templates.

Updated Dec 12, 2025
Search Tags:#templates#documentation#markdown#readme#monorepo#frontmatter
One-click install
npx skills add https://github.com/SatanaCSharp/animemoria --skill package-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: package-docs
Source: https://github.com/SatanaCSharp/animemoria/tree/main/.claude/skills/package-docs
Command: npx skills add https://github.com/SatanaCSharp/animemoria --skill package-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about package-docs

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

FAQPage Schema
How do I generate a standardized README for packages in a monorepo?▼

To generate a standardized README for packages in a monorepo, this Skill inspects your package.json and source files to determine exports, then applies a canonical template with correct frontmatter to packages/<name>/README.md. It ensures consistent structure across all shared packages.

What should a package README include to properly document exports and usage examples?▼

A package README should include documented exports, usage examples, environment requirements, and contribution notes. This Skill reads existing docs and reference files to ensure the final README satisfies the required frontmatter and section structure for the package.

Can I use a specific README template for NestJS-style packages in my documentation workflow?▼

Yes, you can use a canonical template specifically designed for NestJS-style packages. This Skill applies the appropriate variant README template based on the package's structure and exports identified during source file inspection.

How does frontmatter factor into writing package documentation for shared libraries?▼

Frontmatter provides standardized metadata at the top of your package documentation. This Skill ensures the final README placed at packages/<name>/README.md satisfies the required frontmatter fields alongside its section structure for consistent monorepo documentation.

What is the best way to maintain consistent README structure across multiple monorepo packages?▼

The best way to maintain consistent README structure across multiple monorepo packages is to apply a canonical template across all packages. This Skill automates reading existing docs and analyzing exports to standardize frontmatter and sections at packages/<name>/README.md.

Related Skills

Explore More Content & Communication Skills→
parisgroup-aiparisgroup-ai
1

readme-maintenance

Audit and standardize README and AGENTS documentation across monorepo packages.

Official
Intermediate
marinkobabicmarinkobabic

aif-docs

Generate README and topic-based markdown documentation from codebase analysis.

Community
Advanced
pantheon-orgpantheon-org
9

markdown-authoring

Author lint-compliant Markdown documentation with deterministic structure and CI integration.

Official
Intermediate
patricio0312revpatricio0312rev
5

jsdoc-typescript-docs

Generate API documentation from JSDoc comments in TypeScript projects.

Community
Intermediate