skills.rest
sebafermanelli
sebafermanelliCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

sfermanelli-write-docs

Generate JSDoc/TSDoc, READMEs, API docs, and specs as in-repo Markdown.

1|Updated Mar 19, 2026
Search Tags:#documentation#readme#jsdoc#docs#specs#api-docs#tsdoc
One-click install
npx skills add https://github.com/sebafermanelli/sfermanelli-skills --skill sfermanelli-write-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sfermanelli-write-docs
Source: https://github.com/sebafermanelli/sfermanelli-skills/tree/main/sfermanelli-write-docs
Command: npx skills add https://github.com/sebafermanelli/sfermanelli-skills --skill sfermanelli-write-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate clear, maintainable documentation for codebases, including JSDoc/TSDoc, READMEs, API docs, module overviews, and project specs. It ensures docs live in the repository, stay synchronized with code, and can cover architectural decisions, domain models, and business rules.

Core Features & Use Cases

  • Generate in-code documentation artifacts (JSDoc/TSDoc) and external docs (README, API docs, module overviews, specs).
  • Keep docs in sync with code and ADRs, explain bounded contexts, and capture design decisions.
  • Use cases include documenting a new API surface, annotating a library, or creating a spec for a feature.

Quick Start

Provide the codebase and specify the docs to generate (JSdoc, READMEs, API docs, or specs) to create in-repo documentation.

Frequently Asked Questions about sfermanelli-write-docs

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

FAQPage Schema
How do I generate JSDoc and TSDoc annotations for my codebase automatically?▼

To generate JSDoc and TSDoc annotations, provide your codebase and specify the desired documentation format. The system produces in-repo artifacts and inline code comments that stay synchronized with your source code.

What is the best way to keep API docs and READMEs in sync with code changes?▼

The best way to keep API docs and READMEs in sync is to generate in-repo Markdown artifacts that enforce a consistent style and support versioning and PR review workflows. This ensures documentation accurately reflects architectural decisions and bounded contexts.

Can I create project specs and architecture decision records from existing code?▼

Yes, you can create project specs and architecture decision records from existing code. The system extracts API surfaces, domain models, and business rules to produce module overviews and design notes directly from your codebase or requirements.

Does this documentation tool work for documenting new API surfaces and bounded contexts?▼

Yes, this documentation tool works for documenting new API surfaces and bounded contexts. It generates clear module overviews and specs, capturing architectural decisions and explaining domain boundaries for software projects needing up-to-date documentation.

What format are the generated API docs and module overviews stored in?▼

Generated API docs and module overviews are stored as in-repo Markdown artifacts. This format allows documentation to live directly in the repository, enforce a consistent style, and integrate seamlessly with versioning and PR review workflows.

Related Skills

Explore More Software Engineering Skills→
ianpojmanianpojman

knowledge-capture

Capture conversation learnings and update project documentation with markdown entries.

Community
Basic
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate
albertoiruruetaalbertoirurueta

dotnet-code-quality

Run Roslyn analyzers on .NET/C# projects and generate SARIF logs.

Community
Advanced
mintlifymintlify
427

doc-helper

Draft and refine Markdown/MDX documentation within Mintlify-powered sites.

Official
Basic