skills.rest
JNZader-Vault
JNZader-VaultOFFICIAL
Explore all skills by this author →
GitHub

technical-docs

Generate technical documentation with templates for ADRs, OpenAPI, runbooks, and READMEs.

Updated Feb 2, 2026
Search Tags:#documentation#technical writing#adr#readme#api docs#runbooks
One-click install
npx skills add https://github.com/JNZader-Vault/project-starter-framework --skill technical-docs-jnzader-vault
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-docs
Source: https://github.com/JNZader-Vault/project-starter-framework/tree/main/.ai-config/skills/docs/technical-docs
Command: npx skills add https://github.com/JNZader-Vault/project-starter-framework --skill technical-docs-jnzader-vault

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about technical-docs

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

FAQPage Schema
How do I write an Architecture Decision Record for my project?▼

To write an Architecture Decision Record, use a structured template that captures technical decisions, context, and consequences. This Skill provides standardized ADR templates to document architecture choices clearly and consistently across your project.

What is the best way to generate API documentation in OpenAPI and Markdown formats?▼

Generating API documentation is best handled by using structured templates for OpenAPI specifications and Markdown endpoints. This Skill includes examples for both formats to help you document API endpoints clearly and consistently.

How do I create a runbook for operational procedures and troubleshooting?▼

You create a runbook by using a dedicated template to document operational procedures and troubleshooting steps. This Skill provides runbook templates to help you capture essential workflows and recovery actions clearly.

Can I use a template to quickly generate a README for a new software project?▼

Yes, you can use a structured template to quickly generate a well-structured README for a new project. This Skill streamlines README creation, ensuring your project documentation includes clear setup instructions and essential context from the start.

Does this technical writing tool support both API endpoint documentation and architecture docs?▼

Yes, this technical writing tool supports both API endpoint documentation and architecture docs. It generates comprehensive technical documentation, including API docs in OpenAPI and Markdown formats, alongside structured Architecture Decision Records.

Related Skills

Explore More Software Engineering Skills→
Jaydpatel01Jaydpatel01

project-documentation

Generate technical project documentation using templates for READMEs, ADRs, and API docs.

Community
Advanced
tomada1114tomada1114
4

video-script-writing

Generate structured YouTube scripts from Markdown articles, notes, or outlines.

Community
Basic
Ayub-KhanAyub-Khan

documentation

Generate and synchronize README files, API specs, ADRs, and diagrams with source code.

Community
Intermediate
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate