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

nestjs-service-docs

Generate canonical 17-section READMEs for NestJS microservices from codebase inspection.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about nestjs-service-docs

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

FAQPage Schema
How do I auto-generate a NestJS service README in a monorepo?▼

The canonical README structure includes 17 sections covering the service's main module, entrypoints, entities, repositories, controllers, resolvers, and environment examples, ensuring consistent documentation across NestJS microservices.

Can I update an existing NestJS README without losing custom content?▼

The skill aligns generated documentation with the canonical pattern used by existing auth-service and users-service READMEs to ensure cross-service consistency throughout the monorepo.

Does the NestJS README generator work with GraphQL resolvers and TypeORM repositories?▼

No external dependencies are required to run the skill. It operates by directly inspecting the local NestJS codebase, including environment example files, to generate comprehensive documentation.

What's the best way to standardize microservice documentation across a monorepo?▼

By aligning with the established auth-service and users-service README patterns, the skill ensures every generated README maintains the same 17-section structure for reliable cross-service navigation.

Related Skills

Explore More Software Engineering Skills→
moking55moking55

backend-structure

Define standardized NestJS backend modules with controllers, services, entities, and DTOs.

Community
Intermediate
parisgroup-aiparisgroup-ai
1

readme-maintenance

Audit and standardize README and AGENTS documentation across monorepo packages.

Official
Intermediate
FiventsFivents

project-analyzer

Analyze the ONE-ID codebase to extract architecture, data models, and operational flows.

Official
Advanced
pelcherspelchers

creating-project-documentation

Generate Markdown project documentation from repository structure and metadata.

Community
Intermediate