Skills
.Work. You
Rest

nestjs-service-docs

Community

Auto-generate canonical NestJS service READMEs.

Software Engineering#automation#typescript#documentation#readme#monorepo#nestjs#codebase-analysis
AuthorSatanaCSharp
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Automates the creation and updating of canonical README documentation for NestJS microservices within the AniMemoria monorepo, ensuring consistent structure and language across services.

Core Features & Use Cases

  • Generate a standardized 17-section README for a NestJS service by inspecting the service codebase (entry points, modules, entities, repositories, controllers/resolvers) and environment samples.
  • Place the resulting README at apps/<service-name>/README.md; update existing READMEs while preserving content and clearly documenting gaps.
  • Align with the canonical pattern used by auth-service and users-service READMEs to ensure cross-service consistency.

Quick Start

Run the skill with /nestjs-service-docs <service-name> to generate or update apps/<service-name>/README.md based on the service's codebase.

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