This guide explains how to create clear software architecture diagrams by defining architecture concepts, comparing the 4+1 and C4 view models, and offering practical advice on choosing diagram types, tailoring them to audiences, and using visual elements to convey system structure effectively.
The article reviews five essential open-source drawing tools for programmers—Draw.io for versatile diagramming, Excalidraw’s hand-drawn style, Graphviz’s automatic graph layout, Python’s Matplotlib for data visualizations, and PlantUML’s simple markup-based UML creation—highlighting key features, platforms, and typical use cases.
This article explains the purpose and definition of software architecture, outlines various architectural layers such as business, application, technical, and data, introduces the 4+1 and C4 view models, and provides practical guidance on drawing clear, audience‑focused architecture diagrams.
This article provides a comprehensive guide for developers on why documentation matters, what types of technical documents to create, practical templates and formatting rules, and how to maintain and update documentation over time to ensure lasting value.
The article reflects on a technical documentation guide, discusses Tencent's training series, highlights the challenges developers face in finding time for documentation and reviews, and argues that providing sufficient resources is essential for effective documentation practices.
Effective technical documentation requires choosing a searchable knowledge‑base for long‑term storage, writing only value‑adding docs such as architecture designs, feature guides, and onboarding material, following standardized templates and clear formatting rules, assigning owners for regular maintenance, and applying best‑practice principles like accuracy, completeness, and the pyramid structure.
This article explains the fundamental concepts of software architecture, defines what architecture diagrams are and their purposes, evaluates what makes a good diagram, introduces the C4 modeling approach with system context, container, component, and class diagrams, and provides practical case examples and reference resources.
This guide explains the purpose of architecture diagrams, defines what makes a diagram effective, outlines when to draw them, classifies the various diagram types (business, application, technical, code, data), and provides step‑by‑step design principles, visual guidelines, and real‑world examples to help engineers communicate complex systems clearly.
This guide explains how to create clear, visually appealing architecture diagrams—covering purpose, audience, design principles, timing, classification, and step‑by‑step drawing techniques—so teams can communicate structure, workflows, and data effectively across business, product, application, technical, and code domains.
This article explains the fundamental concepts of software architecture, the purpose and classification of architecture diagrams, criteria for good diagrams, and introduces the C4 modeling approach with practical examples to help engineers create clear, self‑describing visualizations for various audiences.
The article explains why technical documentation is often neglected, introduces a document‑quadrant framework to organize content, compares structured and graph‑based approaches, and evaluates tools like Sphinx, Docusaurus, Google Docs, Confluence, and Logseq for creating maintainable, high‑quality documentation.
Implementing micro‑applications for efficiency engineering using a monorepo and micro‑frontend approach, supported by tools like monopower, the company tackled dependency and coupling challenges, cutting migration time by 30% and halving maintenance costs while delivering a robust architecture, testing, and monitoring framework.
This article explains how to create clear and effective software architecture diagrams by defining architecture concepts, describing various diagram types such as business, application, technical and data architectures, introducing the 4+1 and C4 view models, and offering practical tips on audience targeting, visual elements, and consistency with code.
This article explains the purpose and classification of software architecture diagrams, introduces the 4+1 and C4 view models, describes business, application, technical, and data architectures, and provides practical guidance on drawing clear, audience‑focused diagrams that accurately reflect system design.
The article analyzes the challenges of maintaining up‑to‑date technical documentation in fast‑paced development, presents four real‑world case studies, introduces the concept of "live documents" from a recent book, and proposes concrete practices such as ADR logs, automated rule‑to‑doc pipelines, and integrated knowledge bases to improve knowledge retention and usability.
This article explains the purpose and classification of software architecture diagrams, introduces the 4+1 view model and the C4 model, and provides practical guidance on choosing the right view for different audiences to produce clear, self‑describing architectural drawings.
This article explains the concept of system architecture, outlines the classification of architecture diagrams—including the 4+1 and C4 views—describes each view’s purpose and audience, and provides practical guidelines for creating clear, self‑describing diagrams that align with code and stakeholder needs.
This guide explains how to create clear, self‑describing system architecture diagrams by defining architecture concepts, outlining business, application, technical and data layers, and detailing the 4+1 and C4 view models with practical tips for audience‑focused visual communication.
This article explains the purpose and value of software architecture diagrams, defines key concepts and classifications such as context, container, component, and class diagrams, discusses common pitfalls, and presents a practical C4‑based methodology to help architects create clear, audience‑focused diagrams without unnecessary complexity.
This article explains why front‑end technical design documents are essential, illustrates common pitfalls through a developer story, outlines the differences between front‑end and back‑end design, and provides a step‑by‑step template—including chapters, diagrams, and tool recommendations—to help teams produce clear, maintainable specifications.
This article explains why software design documents are essential, outlines the key sections they should contain, offers concrete writing tips, and provides a step‑by‑step process for creating, reviewing, and iterating on design specs to improve project outcomes and reduce risk.
This article provides a comprehensive overview of optical module technology, covering basic concepts, packaging types, classification, and essential performance metrics, and concludes with a download link for additional resources.
This article explains why clear architecture diagrams are essential for communication, defines key concepts, outlines common pitfalls, introduces the 4+1 and C4 modeling approaches, and provides practical tips for creating self‑describing, audience‑oriented diagrams that align with code.
JSSDK is a development tool that enables H5 developers to quickly build apps by facilitating app invocation, cross-platform compatibility, and parameter handling, reducing development time and complexity through modular design and automated version management.
