technical-writer

Generate ADRs, runbooks, API references, and onboarding guides in Markdown.

Updated Mar 14, 2026
One-click install
npx skills add https://github.com/Vivekmano27/agent-orchestrator --skill technical-writer-vivekmano27
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/Vivekmano27/agent-orchestrator/tree/main/plugins/project-orchestrator/skills/technical-writer
Command: npx skills add https://github.com/Vivekmano27/agent-orchestrator --skill technical-writer-vivekmano27

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing and maintaining clear, structured technical documentation for complex microservices projects to ensure consistent knowledge transfer and onboarding.

Core Features & Use Cases

  • Generate ADRs, runbooks, API references, and onboarding guides from high-level requirements.
  • Enforce documentation templates, style guidelines, and Mermaid diagrams for architecture visuals.
  • Improve onboarding and maintenance efficiency by keeping docs close to code and evolving with the project.

Quick Start

Provide a complete ADR, runbook, and API reference for a new microservice.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I generate ADRs and runbooks for a microservices project?

Generate ADRs and runbooks for microservices by applying structured Markdown templates with consistent styling, Mermaid architecture diagrams, and actionable deployment examples to ensure clear knowledge transfer. It creates comprehensive documents from high-level project requirements.

What's the best way to write API references and onboarding guides for multiple services?

Writing API references and onboarding guides for multiple services is best handled by enforcing consistent style guidelines, Mermaid visuals, and actionable examples in Markdown. This ensures structured documentation that evolves closely with code.

Does this approach to technical documentation support Mermaid diagrams for architecture visuals?

Yes, this technical documentation approach supports Mermaid diagrams for architecture visuals. It enforces templates that integrate Mermaid to visually map microservices architecture decisions, deployment procedures, and incident response workflows.

Can I use this method to document deployment procedures and incident response workflows?

Yes, you can use this method to document deployment procedures and incident response workflows. It generates structured runbooks in Markdown that provide actionable steps and consistent style for maintaining microservices operations.

How do I maintain consistent technical writing style across multiple microservices docs?

Maintain consistent technical writing style across microservices by enforcing standardized documentation templates, style guidelines, and structured Markdown formats. This keeps documentation close to code and improves maintenance efficiency.

What is an ADR and when do I need one for architecture decisions?

An ADR, or Architecture Decision Record, is a structured Markdown document capturing technical decisions. You need ADRs for microservices architecture decisions to ensure consistent knowledge transfer, enforce templates, and provide actionable context for developer onboarding.