Generate JSDoc blocks, OpenAPI specs, ADRs, READMEs, and CHANGELOGs.
npx skills add https://github.com/qazuor/claude-code-knowledge --skill tech-writing
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
This Skill standardizes and speeds up documentation creation for software projects.
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.
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.
High-intent search queries and answers about installing and using this skill.
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.
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.
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.
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.
Standardizing CHANGELOG entries is supported across codebases of varying sizes. The skill provides templates and validation patterns to organize and maintain consistent change logs.
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.
klhGenerate and validate docstrings, JSDoc, and OpenAPI specs for Python, TypeScript, and Node.js projects.
korallisAutomates generation of technical documentation for software projects.
armanzeroeightGenerate API documentation from code into HTML or JSON formats.
JongsixGenerate technical documentation from source code and API definitions.
