BestHub
Sign in
Tag

technical documentation

0 views collected around this technical thread.

Tencent Cloud Developer
Tencent Cloud Developer
Sep 12, 2024 · Fundamentals

5 Essential Open-Source Drawing Tools for Programmers: Draw.io, Excalidraw, Graphviz, Matplotlib, and PlantUML

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.

GraphvizMatplotlibPlantUML
0 likes · 9 min read
5 Essential Open-Source Drawing Tools for Programmers: Draw.io, Excalidraw, Graphviz, Matplotlib, and PlantUML
Top Architect
Top Architect
Aug 16, 2024 · Fundamentals

How to Create Effective Software Architecture Diagrams: Definitions, Views, and Best Practices

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.

4+1 viewC4 modelarchitecture diagrams
0 likes · 9 min read
How to Create Effective Software Architecture Diagrams: Definitions, Views, and Best Practices
DevOps
DevOps
Jul 11, 2024 · R&D Management

How to Write Effective Technical Documentation: Guidelines, Templates, and Maintenance

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.

R&D processdocumentation templatesknowledge management
0 likes · 9 min read
How to Write Effective Technical Documentation: Guidelines, Templates, and Maintenance
Continuous Delivery 2.0
Continuous Delivery 2.0
Jul 11, 2024 · Fundamentals

The Importance of Technical Documentation and Resource Allocation for Developers

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.

Best PracticesResource Managementdeveloper productivity
0 likes · 3 min read
The Importance of Technical Documentation and Resource Allocation for Developers
Tencent Cloud Developer
Tencent Cloud Developer
Jul 11, 2024 · Fundamentals

How to Write Effective Technical Documentation: Carriers, Required Docs, Best Practices, Maintenance, and Recommended Reading

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.

developer guidedocumentation best practicesknowledge management
0 likes · 9 min read
How to Write Effective Technical Documentation: Carriers, Required Docs, Best Practices, Maintenance, and Recommended Reading
Top Architect
Top Architect
May 20, 2024 · Fundamentals

Designing Clear Software Architecture Diagrams: Concepts, Types, and the C4 Model

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.

C4 modelarchitecture diagramssoftware architecture
0 likes · 12 min read
Designing Clear Software Architecture Diagrams: Concepts, Types, and the C4 Model
Tencent Cloud Developer
Tencent Cloud Developer
Mar 20, 2024 · Fundamentals

How to Draw Effective Architecture Diagrams: A Comprehensive Guide

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.

System ArchitectureUML diagramsarchitecture diagrams
0 likes · 20 min read
How to Draw Effective Architecture Diagrams: A Comprehensive Guide
Top Architect
Top Architect
Nov 2, 2023 · Fundamentals

Designing Effective Software Architecture Diagrams: Concepts, Types, and Best Practices

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.

C4 modelarchitecture diagramssoftware architecture
0 likes · 13 min read
Designing Effective Software Architecture Diagrams: Concepts, Types, and Best Practices
DevOps
DevOps
Sep 6, 2023 · Fundamentals

Effective Technical Documentation: Structured Docs, Quadrant Model, and Tool Selection

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.

DevOpsSphinxdocumentation tools
0 likes · 8 min read
Effective Technical Documentation: Structured Docs, Quadrant Model, and Tool Selection
DeWu Technology
DeWu Technology
Aug 2, 2023 · Frontend Development

Efficiency Engineering Micro-application Implementation

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.

code couplingdependency managementfront-end development
0 likes · 15 min read
Efficiency Engineering Micro-application Implementation
Top Architect
Top Architect
May 17, 2023 · Fundamentals

How to Draw Effective Architecture Diagrams

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.

4+1 viewC4 modelarchitecture
0 likes · 9 min read
How to Draw Effective Architecture Diagrams
Top Architect
Top Architect
Mar 23, 2023 · Fundamentals

How to Create Effective Software Architecture Diagrams: Methods, Views, and Best Practices

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.

C4 modelarchitecture diagramssoftware architecture
0 likes · 9 min read
How to Create Effective Software Architecture Diagrams: Methods, Views, and Best Practices
Top Architect
Top Architect
Oct 18, 2022 · Fundamentals

How to Create Effective Software Architecture Diagrams: 4+1 and C4 Views

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.

4+1 viewC4 modelarchitecture diagrams
0 likes · 9 min read
How to Create Effective Software Architecture Diagrams: 4+1 and C4 Views
Architecture Digest
Architecture Digest
Oct 18, 2022 · Fundamentals

How to Design Effective System Architecture Diagrams: Definitions, Views, and Best Practices

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.

4+1 viewC4 modelarchitecture diagrams
0 likes · 8 min read
How to Design Effective System Architecture Diagrams: Definitions, Views, and Best Practices
Top Architect
Top Architect
Jan 31, 2022 · Fundamentals

How to Create Effective Software Architecture Diagrams: Concepts, Types, and Best Practices

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.

C4 modelarchitecture diagramssoftware architecture
0 likes · 10 min read
How to Create Effective Software Architecture Diagrams: Concepts, Types, and Best Practices
政采云技术
政采云技术
Dec 14, 2021 · Frontend Development

How to Write Front‑End Technical Design Documents: Purpose, Process, and Best Practices

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.

Best PracticesFront-enddesign specification
0 likes · 14 min read
How to Write Front‑End Technical Design Documents: Purpose, Process, and Best Practices
JD Retail Technology
JD Retail Technology
Oct 27, 2017 · Frontend Development

JSSDK: A Tool for H5 App Development

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.

App InvocationH5 DevelopmentJSSDK
0 likes · 6 min read
JSSDK: A Tool for H5 App Development