BestHub
Sign in
Tag

technical writing

0 views collected around this technical thread.

Architect
Architect
May 9, 2024 · R&D Management

How to Build Technical Influence as a Software Engineer

This article explains why software engineers should cultivate technical influence, outlines the benefits of building a personal brand, and provides practical steps—including continuous learning, contributing to open‑source projects, writing technical articles, delivering talks, and publishing books—to steadily increase visibility and career growth.

career developmentopen sourcepublic speaking
0 likes · 10 min read
How to Build Technical Influence as a Software Engineer
Model Perspective
Model Perspective
Apr 26, 2024 · Fundamentals

5 Powerful Tools to Make Complex Technical Concepts Easy to Understand

This article presents five practical tools—including formulas, examples, visuals, stories, and live demonstrations—to help educators and technologists translate abstract, terminology‑heavy concepts into clear, engaging explanations for diverse audiences.

science communicationstorytellingteaching methods
0 likes · 7 min read
5 Powerful Tools to Make Complex Technical Concepts Easy to Understand
Sanyou's Java Diary
Sanyou's Java Diary
Sep 18, 2023 · Fundamentals

How to Write Effective Technical Articles: Proven Steps and Tips

This guide walks you through the entire process of crafting technical articles—from selecting topics and gathering resources, to structuring drafts, polishing language, using visuals, and final polishing—offering practical tips that help writers produce clear, engaging, and well‑organized content.

article writingcontent creationdocumentation
0 likes · 10 min read
How to Write Effective Technical Articles: Proven Steps and Tips
Continuous Delivery 2.0
Continuous Delivery 2.0
Jun 7, 2023 · Fundamentals

Best Practices for Writing Readable Design Documents

This article presents a comprehensive guide to improving the readability of design documents by covering word choice, concise phrasing, data‑driven statements, avoiding boilerplate, effective sentence and paragraph structures, proper headings, list usage, overall document structure, and provides a template with references for further reading.

Best Practicesdesign documentationreadability
0 likes · 17 min read
Best Practices for Writing Readable Design Documents
Continuous Delivery 2.0
Continuous Delivery 2.0
Jun 6, 2023 · Fundamentals

Design Document Readability: Core Principles, Key Points, and Best Practices

This article explains why design documents need readability, outlines the three essential writing elements—clarity, conciseness, elegance—presents four key design principles such as trade‑offs, the importance of “why” over “how”, time considerations, and avoiding over‑design, and concludes with a brief promotion for a continuous deployment course.

Best Practicesdesign documentationreadability
0 likes · 6 min read
Design Document Readability: Core Principles, Key Points, and Best Practices
Top Architect
Top Architect
Oct 15, 2022 · Fundamentals

Technical Writing Guidelines: Ten Essential Tips for Clear Documentation

This article outlines ten practical principles for improving technical documentation, covering clear subject‑verb‑object sentences, proper use of pronouns and transition words, strong verbs, correct terminology, paragraph structure, effective headings, appropriate length, visual aids, lists, tables, consistent style, overall document architecture, and audience awareness.

Best Practicesdocumentationsoftware engineering
0 likes · 45 min read
Technical Writing Guidelines: Ten Essential Tips for Clear Documentation
Qunar Tech Salon
Qunar Tech Salon
May 23, 2022 · Fundamentals

How to Write Effective Technical Articles: Value, Breakthrough, and Practical Tips

This article shares the author’s experience and practical guidance on writing technical articles, covering why it matters, how to overcome initial hesitation, methods for continuous improvement, and detailed tips on content completeness, logical flow, structure, visual design, and daily habits.

Knowledge Sharingarticle writingcontent creation
0 likes · 15 min read
How to Write Effective Technical Articles: Value, Breakthrough, and Practical Tips
Shopee Tech Team
Shopee Tech Team
Apr 21, 2022 · Backend Development

Interview with Shopee Backend Engineer Draven on Technical Writing, Go Language Design, and Cloud‑Native Development

In this interview, Shopee backend engineer Draven discusses how his early blogging evolved into authoring a comprehensive Go language design book, compares book‑writing to blog series, shares his research‑driven learning methods for new technologies, outlines his current focus on OS, networking and C++, and invites readers to suggest technical books for a World Book Day giveaway.

Backend Developmentcareer developmentcloud-native
0 likes · 10 min read
Interview with Shopee Backend Engineer Draven on Technical Writing, Go Language Design, and Cloud‑Native Development
IT Services Circle
IT Services Circle
Apr 20, 2022 · Fundamentals

The Evolution of Technical Writing: From Early Computer Manuals to Modern Markdown Editors like Yuque

This article traces the history of technical documentation from early computer manuals in the 1940s, through the emergence of markup languages like HTML and Markdown, to modern developer‑focused editors such as Yuque, highlighting why developers favor Markdown and the evolution of Yuque’s editor features.

MarkdownMarkup LanguagesSoftware Development
0 likes · 10 min read
The Evolution of Technical Writing: From Early Computer Manuals to Modern Markdown Editors like Yuque
Top Architect
Top Architect
Apr 1, 2022 · Fundamentals

Technical Writing Best Practices: Ten Essential Guidelines for Effective Documentation

This article presents ten essential guidelines for technical documentation, covering clear subject‑verb‑object sentences, proper use of pronouns and transition words, strong verbs, correct terminology, effective paragraph structure, concise openings, appropriate length, visual aids, lists and tables, consistent style, and overall document architecture.

Best Practicesdocumentationsoftware engineering
0 likes · 45 min read
Technical Writing Best Practices: Ten Essential Guidelines for Effective Documentation
Top Architect
Top Architect
Mar 25, 2022 · Fundamentals

Technical Writing Guidelines: 10 Essential Principles for Clear Documentation

This article presents ten practical principles for technical documentation—including mastering subject‑verb‑object structure, avoiding overuse of pronouns and punctuation, using strong verbs, maintaining consistent terminology, and structuring paragraphs, lists, and tables—to help engineers write clear, concise, and reader‑friendly documents.

Best Practicesdocumentationsoftware engineering
0 likes · 46 min read
Technical Writing Guidelines: 10 Essential Principles for Clear Documentation
Architecture Digest
Architecture Digest
Mar 22, 2022 · Fundamentals

10 Essential Guidelines for Effective Technical Documentation

This article presents ten practical principles for technical writing, covering clear sentence structure, proper use of pronouns and transition words, strong verbs, active voice, minimal adjectives and adverbs, well‑structured paragraphs, concise headings, appropriate lists and tables, effective use of images, consistent style, overall document architecture, and audience targeting.

Best PracticesSoftware Documentationdocumentation
0 likes · 45 min read
10 Essential Guidelines for Effective Technical Documentation
IT Architects Alliance
IT Architects Alliance
Feb 13, 2022 · Fundamentals

10 Key Principles for Effective Technical Writing

This article outlines ten essential guidelines for technical documentation, covering clear subject‑verb‑object construction, proper use of pronouns and transition words, strong verbs, active voice, minimal adjectives and adverbs, consistent terminology, structured paragraphs, appropriate lists and tables, effective use of images, and maintaining a uniform style and overall document structure.

Best Practicescommunicationdocumentation
0 likes · 48 min read
10 Key Principles for Effective Technical Writing
Sohu Tech Products
Sohu Tech Products
Oct 6, 2021 · Fundamentals

How to Write an Effective Technical Article: A Practical Guide

This article outlines a comprehensive workflow for crafting high‑quality technical articles, covering preparation, audience analysis, outline creation, writing techniques, visual aids, interactive demos, and post‑writing polishing to enhance clarity, impact, and personal growth.

article writingcommunicationcontent creation
0 likes · 13 min read
How to Write an Effective Technical Article: A Practical Guide
Top Architect
Top Architect
Aug 22, 2021 · Fundamentals

The Importance of Technical Documentation and How to Produce High‑Quality Docs

This article explains why high‑quality technical documentation is essential for teams and organizations, outlines common reasons engineers avoid writing docs, and provides practical methods—such as treating docs like code, defining the audience, clear classification, and systematic review—to create and maintain effective documentation.

Best Practicesdocumentationsoftware engineering
0 likes · 13 min read
The Importance of Technical Documentation and How to Produce High‑Quality Docs
Ctrip Technology
Ctrip Technology
Jun 10, 2021 · Fundamentals

Understanding Technical Writing: Its Relationship with Programming and How to Practice It

This article explores the connection between programming and writing, defines technical writing, outlines its various forms, explains why developers should engage in it, describes different positioning strategies, and provides a practical model for producing high‑quality technical documents.

Software Developmentcommunicationknowledge management
0 likes · 17 min read
Understanding Technical Writing: Its Relationship with Programming and How to Practice It
ByteFE
ByteFE
Feb 28, 2021 · Fundamentals

What Google Taught Me About Technical Writing

The article shares practical lessons from Google's technical writing course, emphasizing clear, concise, and active‑voice documentation, proper use of pronouns, idioms, lists, and audience‑focused language to help developers produce readable and maintainable technical content.

active voiceclaritycommunication
0 likes · 12 min read
What Google Taught Me About Technical Writing
ByteFE
ByteFE
Feb 25, 2021 · Fundamentals

Key Lessons from Google’s Technical Writing Course

Google's four‑hour technical writing course teaches essential principles such as clarity, succinctness, proper pronoun use, active voice, effective list formatting, and jargon avoidance, offering practical examples and code‑related illustrations to help developers produce clear, maintainable documentation.

active voiceclaritylist usage
0 likes · 12 min read
Key Lessons from Google’s Technical Writing Course
vivo Internet Technology
vivo Internet Technology
Jun 10, 2020 · Backend Development

How to Write Framework Documentation: A Practical Guide Based on Daily Support Experience

Drawing on years of daily support for over ten development frameworks, the guide outlines a comprehensive documentation strategy that covers background, scenarios, integration, quality, best practices, and architecture, organized by functional, process, and description logic to help users solve problems and enhance the framework’s value.

Backend DevelopmentDeveloper Experiencedocumentation best practices
0 likes · 16 min read
How to Write Framework Documentation: A Practical Guide Based on Daily Support Experience