product iamge

Communication Patterns: A Guide for Developers and Architects

This document was uploaded by one of our users. The uploader already confirmed that they had the permission to publish it. If you are author/publisher or own the copyright of this documents, please report to us by using this DMCA report form.

Download
Search on Amazon

Simply click on the Download Book button.

Yes, Book downloads on Ebookily are 100% Free.

Sometimes the book is free on Amazon As well, so go ahead and hit "Search on Amazon"

Having a great idea or design is not enough to make your software project succeed. If you want stakeholders to buy into your design and teams to collaborate and contribute to the vision, you also need to communicate effectively. In this practical book, author Jacqui Read shows you how to successfully present your architecture and get stakeholders to jump on board.

Misunderstanding and lack of buy-in leads to increasing costs, unmet requirements, and an architecture that is not what you intended. Through constructive examples and patterns, this book shows you how to create documentation and diagrams that actually get the message across to the different audiences you'll face.

This book shows you how to:

  • Design diagrams and documentation appropriate to your expected audience, intended message, and project stage
  • Create documentation and diagrams that are accessible to those with varying roles, needs, or disabilities
  • Master written, verbal, and...

    • Author(s): Jacqui Read
    Publisher: O'Reilly Media
    Year: 2023

    Language: English
    Pages: 303

    Preface
    Why I Wrote This Book
    Who Should Read This Book
    How to Read This Book
    Images and Color
    Software Tools
    Polyglot Media
    Conventions Used in This Book
    Using Code Examples
    O’Reilly Online Learning
    How to Contact Us
    Acknowledgments
    I. Visual Communication
    1. Communication Essentials
    Know Your Audience
    Mixing Levels of Abstraction
    Representational Consistency
    Summary
    2. Clarify the Clutter
    Color Overload
    Boxes in Boxes in Boxes
    Relationship Spiderweb
    Balance Text
    Summary
    3. Accessibility
    Relying on Color to Communicate
    Include a Legend
    Appropriate Labels
    Summary
    4. Narrative
    The Big Picture Comes First
    Match Diagram Flow to Expectations
    Clear Relationships
    Summary
    5. Notation
    Using Icons to Convey Meaning
    Using UML for UML’s Sake
    Mixing Behavior and Structure
    Going Against Expectations
    Summary
    6. Composition
    Illegible Diagrams
    Style Communicates
    Misleading Composition
    Create a Visual Balance
    Summary
    II. Multimodal Communication
    7. Written Communication
    Simple Language
    Acronym Hell
    Structured Writing
    Syntax of Technical Writing
    Strong Verbs
    Short Sentences
    Precise Paragraphs
    Consistent Vocabulary
    Audience Empathy
    Summary
    8. Verbal and Nonverbal Communication
    Encoding Messages
    Using the Acceptance Prophecy
    Giving Your Full Attention
    Using Body Language and Gestures
    Decoding Messages
    Battling Bias
    Confirmation bias
    Hindsight bias
    Groupthink
    Being Present
    Awareness of Cultural Differences
    Influence and Persuasion
    Summary
    9. The Rhetoric Triangle
    Ethos
    Establish Your Credentials
    Use Trustworthy Sources
    Be Transparent
    Demonstrate Your Knowledge
    Pathos
    Tell a Story
    Speak from the Heart
    Use Vivid Language and Strong Imagery
    Logos
    Use Data and Facts
    Make Logical Connections
    Use Reasoning and Argumentation
    Summary
    III. Communicating Knowledge
    10. Knowledge Management Principles
    Products over Projects
    Project Mindset
    Product Mindset
    Abstractions over Text
    Lists
    Tables
    Visual Abstractions
    Word Clouds
    Charts, Graphs, and Diagrams
    Other Abstractions
    Perspective-Driven Documentation
    DRY Perspectives
    Fractal Perspectives
    Implementing Perspectives
    Summary
    11. Knowledge and People
    Get Feedback Early and Often
    Share the Load
    Nonproprietary Formats
    Accessibility
    Collaboration
    Roles and Responsibilities
    Further Techniques
    Just-in-Time Architecture
    Summary
    12. Effective Practices
    ADRs
    ADR Structure
    Title and filename
    Status
    Context
    Evaluation Criteria
    Options
    Decision
    Implications
    Consultation
    ADR Content
    ADR Storage
    ADR Culture
    Architecture Characteristics
    All Documentation as Code
    Technical Documentation
    Automatically Generated Documentation
    Other Documentation
    Summary
    IV. Communicating Remotely
    13. Remote Time
    Synchronize Time
    Time Zone
    Empathy and Compromise
    Split Shifts
    Respect Working Patterns
    Communicate Availability
    Defend Part-Time Hours
    Plan for Holidays
    Account for Geography and Culture
    Recognize Real Working Capacity
    Improve Energy and Productivity
    Control Notifications
    Automate Tasks
    Work with Others’ Rhythms
    Schedule for Energy
    Summary
    14. Remote Principles
    Meetings to Sync
    Synchronous Versus Asynchronous
    Enhance Meetings
    Async to Think
    Async Advantages
    Async Obstacles
    Direction Matters
    Async Methods
    Enhance Async
    Remote-First Working
    Remote-First Versus Remote-Friendly
    Remote-First Benefits
    Evolving to Remote-First
    Summary
    15. Remote Channels
    Symmetrical Email
    Email Reasons
    Email Expectations
    Email Clarity
    Email Tips
    Online Presentations
    Audience Engagement
    Presentation Content
    Screen Shares
    Remote Tools and Governance
    Selection Techniques
    Remote Tools
    Data Proliferation
    Security
    Tool Efficiency
    Tool Governance
    Summary
    Epilogue
    A. ADR Templates
    ADR Structure
    Identifier and Title: A Statement of the Decision Made
    Status
    Context
    Evaluation Criteria
    Options
    Decision
    Implications
    Consultation
    ADR Options
    Index