BestHub
Sign in
Tagged articles

Technical Writing

39 articles · Page 1 of 1
Subtle Storm
Subtle Storm
May 14, 2026 · Artificial Intelligence

Boost Architecture Paper Quality Fast with AI: A Practical Step‑by‑Step Guide

The article explains why many architects struggle to turn technical ideas into well‑written papers, how AI can translate those ideas into examiner‑friendly language without replacing critical thinking, and provides a detailed, three‑step workflow—including material preparation, precise prompt engineering, and iterative refinement—to dramatically improve paper quality and efficiency.

AIPrompt EngineeringTechnical Writing
0 likes · 11 min read
Boost Architecture Paper Quality Fast with AI: A Practical Step‑by‑Step Guide
Architecture Breakthrough
Architecture Breakthrough
Nov 18, 2025 · Industry Insights

Why Your Technical Proposal Fails: Lessons on Audience Perspective and Logical Consistency

After a senior’s harsh rejection of a seemingly sound technical proposal, the author realized that writing for outsiders requires explicit context, clear business value, and logical consistency, highlighting how mismatched detail, hidden assumptions, and poor structure can turn a well‑intended document into an unreadable ‘tome’.

DocumentationTechnical Writingcommunication
0 likes · 4 min read
Why Your Technical Proposal Fails: Lessons on Audience Perspective and Logical Consistency
DevOps Coach
DevOps Coach
Oct 10, 2025 · Interview Experience

How I Fast‑Tracked My Software Engineer Career: 10 Practical Growth Hacks

This article shares a software engineer’s eight‑year journey, detailing concrete habits like weekly work logs, on‑call participation, cautious tech adoption, internal team rotation, writing, and interview preparation, offering actionable advice for junior and mid‑level developers seeking rapid career advancement.

Interview PreparationOn-CallSoftware Engineering
0 likes · 24 min read
How I Fast‑Tracked My Software Engineer Career: 10 Practical Growth Hacks
Subtle Storm
Subtle Storm
Feb 25, 2025 · Fundamentals

Mastering Markdown: A Complete Guide to Syntax and Best Practices

This article provides a thorough, step‑by‑step walkthrough of Markdown’s core syntax—headings, paragraphs, line breaks, emphasis, lists, links, images, code blocks—and advanced features such as tables, blockquotes, task lists, horizontal rules, and embedded HTML, while highlighting common use cases and rendering pitfalls.

DocumentationFormattingGitHub
0 likes · 9 min read
Mastering Markdown: A Complete Guide to Syntax and Best Practices
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.

Open SourceSoftware EngineeringTechnical Writing
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.

Technical Writingscience communicationstorytelling
0 likes · 7 min read
5 Powerful Tools to Make Complex Technical Concepts Easy to Understand
Su San Talks Tech
Su San Talks Tech
Nov 1, 2023 · Fundamentals

Master Diagramming with draw.io: Tips, Tools, and Best Practices

This guide explains why diagrams are essential for technical articles, introduces draw.io as a free, cloud‑backed diagramming tool, demonstrates basic shapes, advanced combinations, image hosting options, and also recommends mind‑mapping and code‑screenshot utilities for clearer communication.

Technical Writingcode screenshotsdiagramming
0 likes · 11 min read
Master Diagramming with draw.io: Tips, Tools, and Best Practices
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.

DocumentationTechnical Writingarticle writing
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.

Technical Writingdesign 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.

Technical Writingdesign documentationreadability
0 likes · 6 min read
Design Document Readability: Core Principles, Key Points, and Best Practices
Alipay Experience Technology
Alipay Experience Technology
Apr 14, 2023 · Fundamentals

How to Craft Compelling Technical Sharing Articles: A Step‑by‑Step Guide

This guide outlines practical steps for engineers to create effective technical sharing articles, covering audience identification, purpose definition, outline creation, background framing, solution overview, detailed explanations with principles and examples, result demonstration, insights, and proper acknowledgments.

DocumentationFrontendTechnical Writing
0 likes · 6 min read
How to Craft Compelling Technical Sharing Articles: A Step‑by‑Step Guide
Su San Talks Tech
Su San Talks Tech
Dec 29, 2022 · Fundamentals

Why Every Developer Should Master draw.io for Clear Diagrams

This guide explains why diagrams are essential for technical articles, introduces draw.io as a free, GitHub‑backed tool, walks through its interface, basic shapes, advanced combinations, and also recommends complementary tools like XMind and carbon.now.sh for mind‑maps and code screenshots.

Technical Writingdiagrammingdraw.io
0 likes · 11 min read
Why Every Developer Should Master draw.io for Clear Diagrams
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.

DocumentationSoftware EngineeringTechnical Writing
0 likes · 45 min read
Technical Writing Guidelines: Ten Essential Tips for Clear Documentation
MoonWebTeam
MoonWebTeam
Sep 16, 2022 · Fundamentals

Master the Art of Technical Writing: A Complete Step‑by‑Step Guide

This comprehensive guide explains why writing technical articles matters, outlines the benefits for authors and readers, and provides a detailed, practical process—including topic selection, material collection, outline creation, drafting, title crafting, writing techniques, tools, and standards—to help anyone produce clear, valuable technical content.

Technical Writingarticle tipscontent creation
0 likes · 23 min read
Master the Art of Technical Writing: A Complete Step‑by‑Step Guide
Programmer DD
Programmer DD
Aug 3, 2022 · Fundamentals

What Software Development Looked Like in 1989: A 33‑Year Veteran’s Story

The author recounts three decades of experience in the software industry, describing early work as a technical writer at ACD, the hardware and tools of the era, waterfall SDLC, long‑cycle projects, support nightmares, cultural quirks, and a dramatic US Sprint incident that nearly sank the company.

Legacy SystemsProject ManagementSoftware testing
0 likes · 13 min read
What Software Development Looked Like in 1989: A 33‑Year Veteran’s Story
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.

Technical Writingarticle 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.

Go languageSoftware EngineeringTechnical Writing
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 LanguagesProduct 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.

DocumentationSoftware EngineeringTechnical Writing
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.

DocumentationSoftware EngineeringTechnical Writing
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.

DocumentationTechnical Writingbest practices
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.

DocumentationStyle GuideTechnical Writing
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.

Technical Writingarticle writingcommunication
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.

Software EngineeringTeam CollaborationTechnical Writing
0 likes · 13 min read
The Importance of Technical Documentation and How to Produce High‑Quality Docs
Infra Learning Club
Infra Learning Club
May 21, 2021 · Fundamentals

Google Technical Writing Course – Lesson 1: Core Principles and Practical Tips

This article is a detailed learning note from Google’s Technical Writing course, covering the first lesson’s objectives, essential guidelines such as using professional terminology, reducing pronouns, preferring active voice, crafting clear and concise sentences, structuring lists and tables, and applying Markdown for effective documentation.

DocumentationGoogleMarkdown
0 likes · 12 min read
Google Technical Writing Course – Lesson 1: Core Principles and Practical Tips
Alibaba Terminal Technology
Alibaba Terminal Technology
Mar 23, 2021 · Fundamentals

How to Master Writing Technical Articles: Proven Strategies for Impactful Content

This article explains why writing technical articles boosts personal learning and influence, defines what makes a good article, and offers practical steps—including clear structure, the pyramid principle, 3W2H model, deliberate practice, and iterative refinement—to help anyone craft valuable, engaging technical content.

Feynman TechniqueTechnical Writingarticle structure
0 likes · 9 min read
How to Master Writing Technical Articles: Proven Strategies for Impactful Content
Alibaba Cloud Developer
Alibaba Cloud Developer
Mar 17, 2021 · Fundamentals

Master the Art of Writing Technical Articles: Proven Strategies

This guide explains why writing technical articles boosts personal learning and influence, defines the hallmarks of high‑quality pieces, and offers practical steps—including useful content, clear structure, deliberate practice, and iterative refinement—to help anyone craft compelling, valuable technical documentation.

Feynman TechniqueTechnical Writingarticle structure
0 likes · 8 min read
Master the Art of Writing Technical Articles: Proven Strategies
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.

DocumentationTechnical Writingactive voice
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.

SuccinctnessTechnical Writingactive voice
0 likes · 12 min read
Key Lessons from Google’s Technical Writing Course
Alibaba Terminal Technology
Alibaba Terminal Technology
Sep 14, 2020 · Fundamentals

Why Every Programmer Should Start Writing: Lessons from Three Veteran Developers

This article explores why programmers should write, featuring interviews with three seasoned developers who share how regular writing boosts technical growth, personal branding, problem‑solving skills, and career opportunities, while also revealing unexpected benefits such as networking and deeper learning.

Technical Writingcareer developmentknowledge sharing
0 likes · 14 min read
Why Every Programmer Should Start Writing: Lessons from Three Veteran Developers
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.

Documentation Best PracticesTechnical Writingdeveloper experience
0 likes · 16 min read
How to Write Framework Documentation: A Practical Guide Based on Daily Support Experience
ITPUB
ITPUB
Jul 27, 2016 · Fundamentals

How to Write Effective Technical Blog Posts: Practical Tips for Programmers

This guide explains what constitutes a technical article, why programmers should write them, and offers concrete advice on topic selection, clear structuring, code highlighting, feedback collection, time management, overcoming procrastination, and translation challenges to help produce high‑quality blog posts.

Technical Writingbloggingcontent creation
0 likes · 8 min read
How to Write Effective Technical Blog Posts: Practical Tips for Programmers
21CTO
21CTO
Aug 18, 2015 · Fundamentals

Why Every Programmer Should Start Technical Writing: 5 Surprising Benefits

Technical writing forces programmers to clarify and deepen their understanding, boosts communication skills, invites valuable feedback, expands professional networks, and ultimately builds influence, making it a powerful learning strategy beyond ordinary study methods.

LearningTechnical Writingcareer growth
0 likes · 5 min read
Why Every Programmer Should Start Technical Writing: 5 Surprising Benefits