skills.rest
akshay-na
akshay-naCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

clarity-technical-communication

Document engineering decisions with context, trade-offs, and justification.

4|Updated Oct 31, 2024
Search Tags:#decision making#documentation#technical writing#communication#adr#postmortem
One-click install
npx skills add https://github.com/akshay-na/dotfiles --skill clarity-technical-communication
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: clarity-technical-communication
Source: https://github.com/akshay-na/dotfiles/tree/main/cursor/.cursor/skills/clarity-technical-communication
Command: npx skills add https://github.com/akshay-na/dotfiles --skill clarity-technical-communication

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill enhances your written engineering communication, ensuring decisions are well-documented, trade-offs are clear, and technical reasoning is easily understood by all stakeholders.

Core Features & Use Cases

  • Architecture Decision Records (ADRs): Helps document the context, decision, alternatives, and consequences of significant technical choices.
  • Trade-off Analysis: Guides you in clearly articulating the pros and cons of different options and justifying the chosen path.
  • Postmortems: Assists in writing comprehensive post-incident analyses that identify root causes and actionable improvements.
  • Use Case: When proposing a new database system, use this Skill to draft an ADR that details why you chose PostgreSQL over MongoDB, including the specific performance and scalability trade-offs considered.

Quick Start

Use the clarity-technical-communication skill to draft an architecture decision record for a new feature.

Frequently Asked Questions about clarity-technical-communication

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

FAQPage Schema
How do I write an architecture decision record that clearly documents technical trade-offs?▼

To write an architecture decision record (ADR), document the context, decision, alternatives, and consequences. This ensures your technical trade-offs and reasoning are well-justified for stakeholders.

What should a postmortem include to identify root causes and actionable improvements?▼

A postmortem should include comprehensive post-incident analysis that identifies root causes and actionable improvements. Writing clear postmortems ensures technical reasoning is documented for future engineering decisions.

How do I draft a design proposal that articulates the pros and cons of different technical options?▼

Draft a design proposal by clearly articulating the pros and cons of different options and justifying the chosen path. This trade-off analysis ensures your technical reasoning and chosen architecture are well-documented.

When do I need to document technical context for engineering decisions?▼

You need to document technical context for engineering decisions when proposing new features or systems. Documenting context ensures decisions have clear justification and trade-offs are easily understood by stakeholders.

What is the best way to summarize technical reasoning for stakeholder communication?▼

The best way to summarize technical reasoning is to focus on written engineering communication that highlights trade-offs and consequences. This ensures technical decisions are well-documented and influence stakeholders effectively.

Related Skills

Explore More Content & Communication Skills→
ivanshamaevivanshamaev
14

de-architecture-decision

Generate Data Engineering Architecture Decision Records with weighted trade-off scoring.

Community
Intermediate
baasith6baasith6

architecture-decision-records

Document technical decisions using structured Architecture Decision Records with sequential numbering.

Community
Intermediate
legioncodeinclegioncodeinc
72

adr-writing-stinger

Create Architecture Decision Records with context, alternatives, and consequences.

Official
Advanced
czh-ee-2023czh-ee-2023

patent-pipeline

Orchestrate patent drafting with prior art search and jurisdiction formatting.

Community
Advanced