Skills
.Work. You
Rest

technical-docs

Official

Craft clear technical documentation.

Software Engineering#documentation#technical writing#adr#readme#api docs#runbooks
AuthorJNZader-Vault
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill streamlines the creation of essential technical documentation, ensuring clarity, consistency, and completeness across your projects.

Core Features & Use Cases

  • Structure Documentation: Provides templates for organizing docs, including architecture, API, guides, and runbooks.
  • Write ADRs: Offers a structured template for Architecture Decision Records to capture key decisions.
  • Generate API Docs: Includes examples for both OpenAPI specifications and Markdown-based endpoint documentation.
  • Create Runbooks: Provides a template for documenting operational procedures and troubleshooting.
  • Use Case: When starting a new project, use this Skill to quickly generate a well-structured README, set up an ADR process, and document initial API endpoints.

Quick Start

Use the technical-docs skill to generate a README file for a new project.

Dependency Matrix

Required Modules

None required

Components

references

💻 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: technical-docs
Download link: https://github.com/JNZader-Vault/project-starter-framework/archive/main.zip#technical-docs

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 223,000+ vetted skills library on demand.