technical-communication

Improve technical writing across documentation, code comments, and communications.

7|Updated Jan 29, 2026

Search Tags:#documentation #style-guide #technical-writing #code-comments #commit-messages #adrs #readmes

Ready to run

npx skills add https://github.com/joabgonzalez/ai-agents-skills --skill technical-communication

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: technical-communication
Source: https://github.com/joabgonzalez/ai-agents-skills/tree/main/skills/technical-communication
Command: npx skills add https://github.com/joabgonzalez/ai-agents-skills --skill technical-communication

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Clear technical writing for documentation and commits, enabling teams to communicate concepts accurately and consistently.

Core Features & Use Cases

Provides clear, concise writing guidelines for API docs, READMEs, ADRs, and inline code comments.
Offers templates and rules to ensure consistent commit messages, PR descriptions, and architectural decisions.
Helps teams translate complex technical ideas into actionable, easy-to-understand content with real-world examples.

Quick Start

Apply consistent technical writing standards across your documentation and code comments by following concise prompts.

Frequently Asked Questions about technical-communication

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

FAQPage Schema

How do I write clear technical documentation for API docs and READMEs?▼

Clear technical documentation requires structured guidance, active voice, and concise formatting. Apply these standards to API docs and READMEs to produce precise, actionable text with consistent examples.

What is the best way to format commit messages and PR descriptions?▼

Formatting commit messages and PR descriptions requires templates and rules for consistency. Apply predefined standards to ensure structured, clear communication across pull requests and version control history.

How do I write effective inline code comments?▼

Effective inline code comments require precise, actionable text. Apply concise writing guidelines to inline notes to clarify complex logic and maintain consistent documentation standards across your software project.

When do I need to write an Architecture Decision Record?▼

You need an Architecture Decision Record (ADR) to document architectural decisions consistently. Use structured templates to translate technical decisions into actionable, easy-to-understand content for your team.

Can I enforce a consistent style guide across all technical writing?▼

You can enforce a consistent style guide by applying structured writing rules across all documentation. This ensures precise, actionable text and consistent formatting standards for API docs, READMEs, and ADRs.