tech-writing

Generate JSDoc blocks, OpenAPI specs, ADRs, READMEs, and CHANGELOGs.

Updated Feb 5, 2026

Search Tags:#documentation #OpenAPI #ADR #README #CHANGELOG #JSDoc

Ready to run

npx skills add https://github.com/qazuor/claude-code-knowledge --skill tech-writing

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: tech-writing
Source: https://github.com/qazuor/claude-code-knowledge/tree/main/skills/tech-writing
Command: npx skills add https://github.com/qazuor/claude-code-knowledge --skill tech-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill standardizes and speeds up documentation creation for software projects.

Core Features & Use Cases

It covers JSDoc and TSDoc, OpenAPI/Swagger specifications, Architecture Decision Records (ADRs), README structures, and CHANGELOGs, with practical examples and guidance for realistic use cases. It provides templates and examples that you can adapt to your codebase, such as generating JSDoc blocks, OpenAPI specs, ADR templates, and standardized READMEs.

Quick Start

To begin, ask the AI to generate a JSDoc block for a function, or request a README skeleton for a new module; or request OpenAPI spec scaffolding for a new API.

Frequently Asked Questions about tech-writing

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

FAQPage Schema

How do I generate a JSDoc block for a function?▼

To generate a JSDoc block, provide the function code to the AI and request documentation. This approach uses structured templates to standardize code documentation and speed up the creation process.

How do I write an Architecture Decision Record for a new module?▼

Writing an Architecture Decision Record is simplified by requesting an ADR template from the AI. This provides a standardized structure to document architectural choices and context for your software project.

What's the best way to structure a README for a new software project?▼

Structuring a README is done by requesting a standardized skeleton from the AI. This method ensures consistent documentation patterns and covers essential sections for new software modules.

How do I create OpenAPI spec scaffolding for a new API?▼

Creating OpenAPI spec scaffolding involves asking the AI to generate the initial specification structure. This standardizes API documentation and accelerates the setup of Swagger and OpenAPI definitions.

Can I standardize CHANGELOG entries across a codebase of varying sizes?▼

Standardizing CHANGELOG entries is supported across codebases of varying sizes. The skill provides templates and validation patterns to organize and maintain consistent change logs.

Does this documentation approach work for both JSDoc and TSDoc formats?▼

This approach works for both JSDoc and TSDoc formats. It provides practical examples and templates that you can adapt to your codebase to standardize technical documentation generation.