Tagged articles
Technical Writing
42 articles · Page 1 of 1
The author configures Codex to use simple English via AGENTS.md, creating a workflow where they read AI responses in English first, request simplifications when stuck, and practice writing by mixing Chinese and English, turning daily development into incremental language learning.
AGENTS.mdCodexCoding Agent
0 likes · 16 min read

The article argues that AI generation speed outpaces human review capacity, creating a bottleneck. It proposes adopting aviation's Simplified Technical English principles—short sentences, consistent terminology, active voice, structured steps—to make AI outputs more readable. It also recommends diagrams for relationships, interactive web pages for parameter exploration, and explainer videos for complex reasoning, while preserving verification checkpoints with evidence, conditions, and risks.
AI output reviewASD-STE100Diagrams
0 likes · 16 min read

The article explains why seasoned engineers struggle with writing technical documents, identifies two root causes—rigid thinking and limited writing skill—and presents ten concrete guidelines, illustrated with real‑world examples, to help architects produce clear, structured, and reader‑friendly documentation.
Best PracticesDiagramsTechnical Writing
0 likes · 46 min read

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.
AITechnical Writingexam preparation
0 likes · 11 min read

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’.
Technical Writingcommunicationdocumentation
0 likes · 4 min read

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 PreparationTechnical Writingcareer development
0 likes · 24 min read

This guide explains non‑finite verbs—especially infinitives and gerunds—their forms, functions as nouns, adjectives, or adverbs, and provides clear rules for choosing the right form in technical writing, complete with practical examples and usage tips.
EnglishGerundInfinitive
0 likes · 9 min read

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.
FormattingGitHubMarkdown
0 likes · 9 min read

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.
Technical Writingcareer developmentopen-source
0 likes · 10 min read

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

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.
Draw.ioTechnical Writingcode screenshots
0 likes · 11 min read

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.
Technical Writingarticle writingcontent creation
0 likes · 10 min read

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

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

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.
Best PracticesTechnical Writingdocumentation
0 likes · 6 min read

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.
Draw.ioTechnical Writingdiagramming
0 likes · 11 min read

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 PracticesTechnical Writingdocumentation
0 likes · 45 min read

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

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.
Software HistoryTechnical Writinglegacy systems
0 likes · 13 min read

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

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 LanguageTechnical Writingbackend development
0 likes · 10 min read

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 LanguagesTechnical Writing
0 likes · 10 min read

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.
Technical Writingdocumentationsoftware engineering
0 likes · 45 min read

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.
Technical Writingdocumentationsoftware engineering
0 likes · 46 min read

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 PracticesTechnical Writingdocumentation
0 likes · 45 min read

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.
Style GuideTechnical Writingcommunication
0 likes · 48 min read

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

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.
Technical Writingsoftware engineeringteam collaboration
0 likes · 13 min read

This guide shares practical techniques for producing high‑quality technical articles, emphasizing the importance of solid content, clear structure, engaging narratives, and effective formatting to help engineers consistently create valuable and readable posts.
Technical Writingarticle tipscommunication
0 likes · 11 min read

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.
Technical Writingcommunicationknowledge management
0 likes · 17 min read

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.
GoogleMarkdownStyle Guide
0 likes · 12 min read

This article shares practical techniques for crafting high‑quality technical articles, emphasizing solid content, clear structure, engaging narratives, and effective writing habits to help engineers produce useful and readable documentation.
Technical Writingarticle tipscommunication
0 likes · 12 min read

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

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


ByteFEFeb 28, 2021 · Fundamentals
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.
Technical Writingactive voiceclarity
0 likes · 12 min read


ByteFEFeb 25, 2021 · Fundamentals
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

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

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

This article outlines the essential efforts required to excel at API documentation, covering code comprehension, collaboration with engineers, crafting non‑reference guides, understanding readers, mapping dependencies, learning resources, and leveraging tools like Swagger and README.io.
API DocumentationBest PracticesREADME.io
0 likes · 8 min read


ITPUBJul 27, 2016 · Fundamentals
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


21CTOAug 18, 2015 · Fundamentals
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

This guide outlines a step‑by‑step mind map for writing effective technical articles, covering audience focus, simplicity, logical ordering, brevity, iterative refactoring, visual aids, and accuracy to help readers produce clear and engaging content.
Technical Writingarticle structureclarity
0 likes · 6 min read
