tech-writing

Community

Streamline software docs with proven patterns.

Authorqazuor
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: tech-writing
Download link: https://github.com/qazuor/claude-code-knowledge/archive/main.zip#tech-writing

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.