nerdev-docs

Generates development-integrated documentation including ADRs, design docs, incident postmortems, and deploy runbooks.

1|Updated Aug 17, 2026
One-click install
npx skills add https://github.com/NalinDalal/skillset --skill nerdev-docs-nalindalal
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: nerdev-docs
Source: https://github.com/NalinDalal/skillset/tree/main/skills/nerdev/nerdev-docs
Command: npx skills add https://github.com/NalinDalal/skillset --skill nerdev-docs-nalindalal

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Engineering teams often treat documentation as an afterthought, leaving architecture decisions, incident learnings, and deployment procedures undocumented or scattered. This Skill establishes a docs-as-code workflow where ADRs, design docs, postmortems, and runbooks live in the repo, version with code, and serve both humans and AI agents. ## Core Features & Use Cases - Nine Document Types: Templates and conventions for AGENTS.md, ADRs, design docs, architecture minimaps, feature timelines, incident postmortems, deploy runbooks, API contracts, and contribution guides. - Generation Scripts: Bun-based scripts (adr:new, design:new, incident:new, openapi:gen) that scaffold documents from templates with automatic dating and numbering. - Docs CI Pipeline: Markdown linting, link checking, and automated OpenAPI/AsyncAPI generation via GitHub Actions. - Use Case: After a production WebSocket outage, run the incident script to scaffold a postmortem in docs/incidents/, fill in the timeline and root cause, and check off prevention items in the same PR as the fix. ## Quick Start Ask the agent to scaffold the docs structure and create a new ADR for your latest architecture decision using the nerdev-docs templates.

Frequently Asked Questions about nerdev-docs

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

FAQPage Schema
How do I write an architecture decision record (ADR)?▼

Run the adr:new script with a short title to scaffold a dated file in docs/adr/ from the template. Fill in Status, Context, Decision, Consequences, and Alternatives Considered, then commit it in the same PR as the related code change.

What documentation should a software project maintain?▼

This Skill defines nine types: AGENTS.md for AI agents, ADRs for decisions, design docs for features, an architecture minimap with Mermaid diagrams, a feature timeline, incident postmortems, a deploy runbook, generated API contracts, and a contribution guide.

How do I generate OpenAPI docs from code?▼

Add the openapi:gen script to package.json, which generates openapi.yaml from Elysia route definitions. Event-driven systems can similarly produce asyncapi.yaml from event definitions, and both regenerate in CI.

Can AI coding agents use this documentation?▼

Yes. AGENTS.md gives agents project overview, conventions, and common tasks, while code annotations like @ai-context and @ai-related-files guide agent navigation. The agent-docs-writer skill handles AGENTS.md generation.

How do I enforce documentation quality in CI?▼

The Skill provides a GitHub Actions workflow running markdownlint and markdown-link-check on every change, plus a docs-generate job that rebuilds OpenAPI specs and uploads generated docs as artifacts.