technical-writing

Write and structure technical documentation using standardized templates for APIs, tutorials, ADRs, and runbooks.

Updated May 6, 2026

Search Tags:#architecture #documentation #tutorials #runbooks #technical-writing #api-docs #adrs

Ready to run

npx skills add https://github.com/Abdullahmohammadaref/acar --skill technical-writing-abdullahmohammadaref

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/Abdullahmohammadaref/acar/tree/main/.agents/skills/technical-writing
Command: npx skills add https://github.com/Abdullahmohammadaref/acar --skill technical-writing-abdullahmohammadaref

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Write, review, and structure clear, actionable technical documentation for software projects across APIs, tutorials, ADRs, and runbooks to reduce onboarding time and friction.

Core Features & Use Cases

API documentation templates and examples that reflect real-world endpoints
Tutorial structures, ADR templates, and runbook patterns to standardize workflows
Reference material and cross-linking templates to keep docs cohesive and up-to-date

Quick Start

Provide standardized templates and practical examples to start writing high-quality docs immediately.

Frequently Asked Questions about technical-writing

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

FAQPage Schema

How do I write technical documentation for software APIs and tutorials?▼

To write technical documentation for software APIs and tutorials, use standardized templates and reference examples that enforce consistent structure, ensuring readability and reducing project onboarding friction.

What is the best way to structure architecture decision records for software projects?▼

The best way to structure architecture decision records is using standardized ADR templates that capture decisions consistently, providing reference material and cross-linking to keep project documentation cohesive and up-to-date.

How do I create runbooks that standardize operational workflows across teams?▼

To create runbooks that standardize operational workflows across teams, apply structured runbook patterns and templates that enforce consistent formatting, ensuring actionable and reliable documentation for production environments.

Can I use standardized templates for API docs across different software projects?▼

Yes, you can use standardized API documentation templates across different software projects to reflect real-world endpoints, enforce formatting consistency, and provide practical examples for technical authors immediately.

When do I need formal templates for technical writing instead of freeform documentation?▼

You need formal templates for technical writing when onboarding time and friction are high, requiring standardized formats for ADRs, runbooks, and API docs to ensure consistency and readability across multiple engineering teams.