BestHub
Sign in
Tagged articles

documentation

245 articles · Page 2 of 3
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.

best practicesdocumentationfrontend
0 likes · 6 min read
How to Craft Compelling Technical Sharing Articles: A Step‑by‑Step Guide
Continuous Delivery 2.0
Continuous Delivery 2.0
Mar 30, 2023 · Fundamentals

How to Write Effective Design Documents: Principles and Practices

This article outlines the purpose, structure, and best‑practice guidelines for creating concise, actionable design documents, covering context, goals, actual design, alternatives, cross‑cutting concerns, and the document lifecycle, while explaining when such documentation is beneficial and when it may be unnecessary.

design docsdocumentationproject management
0 likes · 12 min read
How to Write Effective Design Documents: Principles and Practices
Architecture Digest
Architecture Digest
Mar 28, 2023 · Artificial Intelligence

How ChatGPT Assists Developers: Benefits, Use Cases, and Limitations

This article explains how ChatGPT, the popular AI chatbot, can boost developer productivity through testing, debugging, documentation, error detection, code completion, formatting, refactoring, search assistance, text classification, and summarization, while also highlighting its need for human oversight and risks such as plagiarism.

ChatGPTDeveloper Toolsartificial-intelligence
0 likes · 7 min read
How ChatGPT Assists Developers: Benefits, Use Cases, and Limitations
Programmer DD
Programmer DD
Mar 5, 2023 · Backend Development

Spring Boot 3.0.4 Release: Key Bug Fixes, Docs Updates, and Dependency Upgrades

Spring Boot 3.0.4 arrives early, addressing a PathMatchingResourcePatternResolver issue that broke bean and controller scanning, and brings 19 bug fixes, documentation enhancements for Gradle 8 and other topics, plus numerous dependency upgrades across Couchbase, Jetty, Reactor, Spring Framework, and more.

Backend DevelopmentBug FixesSpring Boot
0 likes · 4 min read
Spring Boot 3.0.4 Release: Key Bug Fixes, Docs Updates, and Dependency Upgrades
HelloTech
HelloTech
Feb 28, 2023 · Frontend Development

Design and Implementation of a Taro Component Library with Integrated Documentation and Demo

The article describes building a Taro component library whose components, documentation and live demos are generated from a single Markdown source, using Rollup‑built ES modules, a Vite‑based static site, a custom webpack markdown loader, and an isolated H5 demo project to ensure maintainable, reusable code and synchronized documentation.

Component LibraryTaROTypeScript
0 likes · 10 min read
Design and Implementation of a Taro Component Library with Integrated Documentation and Demo
Java Architecture Diary
Java Architecture Diary
Feb 24, 2023 · Backend Development

What’s New in Spring Boot 3.2.0? Bug Fixes, Docs, and Dependency Upgrades Explained

Spring Boot 3.2.0 introduces a series of bug fixes—including Logback AOT handling, native image configuration, and LDAP dependencies—updates documentation for configuration properties and Redis, and upgrades core libraries such as Byte Buddy, Caffeine, and Hibernate, providing a more stable and up‑to‑date platform for Java developers.

JavaSpring Bootdocumentation
0 likes · 4 min read
What’s New in Spring Boot 3.2.0? Bug Fixes, Docs, and Dependency Upgrades Explained
Open Source Linux
Open Source Linux
Feb 22, 2023 · Fundamentals

Mastering the Software Architect Role: Skills, Decisions, and Daily Practices

This article explores what a software architect does, the different levels of architecture, essential daily activities, key skills such as design, decision‑making, communication, estimation, and marketing, and offers practical advice on continuous learning, documentation, and influencing stakeholders.

architect skillscommunicationdecision making
0 likes · 17 min read
Mastering the Software Architect Role: Skills, Decisions, and Daily Practices
IT Architects Alliance
IT Architects Alliance
Feb 7, 2023 · Fundamentals

Key Skills and Practices for Software Architects

This article provides a comprehensive guide to software architecture, detailing the three architecture levels, daily activities, ten essential skills, decision‑making techniques, communication strategies, documentation practices, and ways to balance quality, cost, and time while fostering continuous learning and community involvement.

architect skillscommunicationcontinuous learning
0 likes · 16 min read
Key Skills and Practices for Software Architects
Architects' Tech Alliance
Architects' Tech Alliance
Feb 5, 2023 · R&D Management

Key Skills and Practices for Software Architects

This article outlines the role of a software architect, describing the different architectural levels, daily activities, essential skills such as design, decision‑making, communication, documentation, estimation, and how to balance technical and non‑technical responsibilities for effective system design.

architect skillscommunicationdecision making
0 likes · 18 min read
Key Skills and Practices for Software Architects
Selected Java Interview Questions
Selected Java Interview Questions
Feb 2, 2023 · Frontend Development

LowCodeEngine: An Open‑Source Low‑Code Engine from Alibaba DingTalk Team

LowCodeEngine is an open‑source low‑code engine released by Alibaba's DingTalk team that follows internal construction protocols, supports modern browsers, offers a minimal core with a rich ecosystem, provides TypeScript typings, and includes extensive UI panels, schema editing, and multiple CDN integration options for developers.

AlibabaEngineTypeScript
0 likes · 8 min read
LowCodeEngine: An Open‑Source Low‑Code Engine from Alibaba DingTalk Team
21CTO
21CTO
Jan 29, 2023 · R&D Management

Why Google’s Design Docs Are Essential for Successful Software Projects

This article explains how Google’s informal yet structured design documents improve software quality by clarifying goals, trade‑offs, and cross‑team concerns, while outlining when to write them, their ideal length, review process, and lifecycle to foster shared understanding and efficient development.

Googledesign docsdocumentation
0 likes · 15 min read
Why Google’s Design Docs Are Essential for Successful Software Projects
Architect
Architect
Jan 22, 2023 · Fundamentals

The Unspoken Realities of a Software Engineer’s Career

This article reveals the hidden challenges of software engineering, emphasizing that most developers spend little time writing code and more on maintenance, documentation, dealing with incompetent colleagues, uncertainty, estimations, and meetings, urging newcomers to accept these realities and focus on delivering value.

Career Advicedeveloper lifedocumentation
0 likes · 13 min read
The Unspoken Realities of a Software Engineer’s Career
DevOps
DevOps
Dec 26, 2022 · Product Management

Understanding Product Feature Lists: Definition, Benefits, and Presentation Methods

This article explains what a product feature list is, how it fits into product planning and architecture, outlines its benefits for development and MVP definition, describes common presentation formats, and emphasizes its dynamic nature while also mentioning a related DevOps hackathon event.

MVPProduct Architecturedocumentation
0 likes · 5 min read
Understanding Product Feature Lists: Definition, Benefits, and Presentation Methods
Architecture Digest
Architecture Digest
Dec 17, 2022 · Fundamentals

How to Become a Software Architect: Roles, Levels, Skills, and Practices

This article outlines the path to becoming a software architect, detailing the role’s definition, architectural levels, daily activities, essential skills such as design, decision‑making, documentation, communication, and provides practical advice on learning, community building, and balancing technical and non‑technical responsibilities.

career developmentcommunicationdecision making
0 likes · 17 min read
How to Become a Software Architect: Roles, Levels, Skills, and Practices
macrozheng
macrozheng
Dec 12, 2022 · Backend Development

Designing Secure, Reliable APIs: Signatures, Encryption, Rate Limiting & More

Learn how to design robust, secure API interfaces by implementing signatures, encryption, IP whitelists, rate limiting, parameter validation, unified responses, exception handling, logging, idempotency, request size limits, load testing, asynchronous processing, data masking, and comprehensive documentation to ensure stability and safety.

API designLoggingdocumentation
0 likes · 15 min read
Designing Secure, Reliable APIs: Signatures, Encryption, Rate Limiting & More
DataFunSummit
DataFunSummit
Nov 16, 2022 · Artificial Intelligence

Designing Effective APIs for AI Open‑Source Software

This article explains why API design is crucial for AI open‑source projects, outlines the new challenges faced, presents three fundamental design principles with concrete examples, and offers practical guidance on documentation, error handling, and evaluation to create user‑friendly, scalable AI software ecosystems.

AI softwareAPI designError handling
0 likes · 11 min read
Designing Effective APIs for AI Open‑Source Software
Architecture Digest
Architecture Digest
Nov 1, 2022 · Fundamentals

How to Become a Software Architect – Skills, Roles, and Guidance

This comprehensive guide explains what a software architect does, outlines the three levels of architecture, details daily activities, essential skills, decision‑making, documentation, communication, and provides practical advice for aspiring architects.

career developmentcommunicationdecision making
0 likes · 18 min read
How to Become a Software Architect – Skills, Roles, and Guidance
MaGe Linux Operations
MaGe Linux Operations
Oct 31, 2022 · Fundamentals

Why Good Code Comments Matter: Debunking the No‑Comment Myth

The article argues that code comments are essential, explaining why ignoring them leads to unreadable, error‑prone software, and demonstrates that even brief annotations can save hours of debugging, especially after months of neglect or when others inherit the code.

best practicescode commentsdocumentation
0 likes · 11 min read
Why Good Code Comments Matter: Debunking the No‑Comment Myth
Architect's Guide
Architect's Guide
Oct 26, 2022 · Fundamentals

How to Become a Software Architect: Roles, Skills, and Practices

This article explains what a software architect does, outlines the three levels of architecture, lists daily activities and ten essential skills—including design, decision‑making, communication, documentation, estimation, and marketing—while offering practical advice on design patterns, quality metrics, technology experimentation, documentation automation, conflict resolution, and influencing stakeholders.

architect skillscommunicationdecision making
0 likes · 18 min read
How to Become a Software Architect: Roles, Skills, and 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
Rare Earth Juejin Tech Community
Rare Earth Juejin Tech Community
Oct 9, 2022 · Frontend Development

Front‑End Development Standards and Best Practices

This comprehensive guide outlines front‑end development standards—including naming conventions, technology‑stack choices, programming rules, Git workflow, BFF design, front‑back collaboration, IDE settings, testing strategies, and documentation—to improve code maintainability, team efficiency, and project quality.

Git WorkflowNaming Conventionscode review
0 likes · 20 min read
Front‑End Development Standards and Best Practices
ITFLY8 Architecture Home
ITFLY8 Architecture Home
Sep 28, 2022 · Databases

10 Essential Database Design Practices Every Developer Should Follow

This article explains why solid database design is crucial for scalable applications and outlines ten best‑practice guidelines—including stakeholder input, choosing the right DB type, consistent naming, normalization, documentation, security, scalability, stored procedures, modeling time, and thorough testing.

Database Designbest practicesdocumentation
0 likes · 9 min read
10 Essential Database Design Practices Every Developer Should Follow
DeWu Technology
DeWu Technology
Sep 22, 2022 · R&D Management

How DTDD Transformed API Documentation and Testing at DeWu: A Deep Dive

This article analyzes the challenges of fragmented API documentation workflows at DeWu, introduces the Document‑&‑Test‑Driven Development (DTDD) model, and details the architectural and procedural improvements—including data asset consolidation, multi‑level classification, mock services, and automated testing—that boosted documentation utilization and reduced development friction.

API ManagementMockPlatform Integration
0 likes · 15 min read
How DTDD Transformed API Documentation and Testing at DeWu: A Deep Dive
Java Baker
Java Baker
Aug 28, 2022 · Backend Development

Essential Productivity Tools Every Backend Engineer Should Use

This guide introduces a curated set of diagramming, documentation, IDE, and terminal tools—including draw.io, uTools, PlantUML, IntelliJ IDEA, XMind, mdnice, GitBook, MobaXterm, and JuiceSSH—to help backend developers create design docs and diagrams more efficiently and securely.

IDETerminaldiagramming
0 likes · 7 min read
Essential Productivity Tools Every Backend Engineer Should Use
21CTO
21CTO
Jul 17, 2022 · Fundamentals

Why Software Design Docs Matter: Master UML Modeling for Clear Architecture

This article explains the fundamentals of software design documentation, showing how UML modeling—class, sequence, component, deployment, use‑case, state, and activity diagrams—captures domain problems and system structure across requirement, high‑level, and detailed design phases, enabling architects to communicate intent to diverse stakeholders.

UMLarchitecturedocumentation
0 likes · 13 min read
Why Software Design Docs Matter: Master UML Modeling for Clear Architecture
Alibaba Terminal Technology
Alibaba Terminal Technology
Jul 6, 2022 · Frontend Development

Inside React Labs’ June 2022 Updates: Server Components, Offscreen, and New Docs

The June 2022 React Labs post reveals ongoing experiments such as Server Components, asset loading deduplication, static server‑rendering optimizations, a new optimizing compiler with a Playground, the Offscreen API, transition tracing tools, and a revamped documentation site focused on hooks and performance.

OffscreenReActServer Components
0 likes · 14 min read
Inside React Labs’ June 2022 Updates: Server Components, Offscreen, and New Docs
Java High-Performance Architecture
Java High-Performance Architecture
Apr 7, 2022 · Frontend Development

Discover Vue 3’s New Documentation: Features, Guides, and a 50‑Map Study Notebook

This article introduces the freshly released Chinese Vue 3 documentation, outlines its ten major updates—including dark mode, responsive design, API style switching, and VitePress integration—provides a comprehensive study notebook with 50 mind‑maps, and offers download links for the original xmind files.

TypeScriptVue 3documentation
0 likes · 10 min read
Discover Vue 3’s New Documentation: Features, Guides, and a 50‑Map Study Notebook
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 communication
0 likes · 45 min read
Technical Writing Best Practices: Ten Essential Guidelines for Effective Documentation
macrozheng
macrozheng
Mar 30, 2022 · Frontend Development

Build a Powerful Documentation Site with VuePress Hope Theme

This guide explains how to use the VuePress Hope theme to create feature‑rich project documentation and blog sites, covering installation, configuration of navigation, sidebars, icons, site information, home pages, code highlighting, and category/tag support.

ThemeVuePressdocumentation
0 likes · 13 min read
Build a Powerful Documentation Site with VuePress Hope Theme
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.

best practicesdocumentationsoftware documentation
0 likes · 45 min read
10 Essential Guidelines for Effective Technical Documentation
GrowingIO Tech Team
GrowingIO Tech Team
Mar 10, 2022 · Frontend Development

How We Replaced Gitbook with Docusaurus for Scalable Documentation

Facing limitations with Gitbook for SaaS and private deployments, we rebuilt our help documentation platform using Docusaurus, detailing the challenges of multi‑version support, changelog review, offline export, and the step‑by‑step setup, configuration, and deployment processes that streamlined our documentation workflow.

DocusaurusPDF exportSearch
0 likes · 15 min read
How We Replaced Gitbook with Docusaurus for Scalable Documentation
Sohu Tech Products
Sohu Tech Products
Mar 9, 2022 · Backend Development

Understanding the Spring Transaction Rollback Bug and Its Resolution

This article analyzes a Spring transaction rollback issue caused by the use of pattern‑based exception matching, explains why certain custom exceptions trigger unexpected rollbacks, traces the problem through source code and GitHub issues, and describes how the Spring team fixed it with type‑safe rollback rules and documentation updates.

JavaRollbackSpring
0 likes · 22 min read
Understanding the Spring Transaction Rollback Bug and Its Resolution
IT Services Circle
IT Services Circle
Feb 17, 2022 · Frontend Development

Using Mermaid Diagrams in GitHub Markdown: A Quick Introduction

GitHub now integrates the Mermaid diagram plugin into Markdown, allowing developers to embed flowcharts, sequence diagrams, Gantt charts, and more directly in documentation using simple text syntax, which streamlines visualization, reduces maintenance overhead, and enhances collaborative understanding of project architectures.

GitHubMarkdownMermaid
0 likes · 5 min read
Using Mermaid Diagrams in GitHub Markdown: A Quick Introduction
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.

Style Guidecommunicationdocumentation
0 likes · 48 min read
10 Key Principles for Effective Technical Writing
MaGe Linux Operations
MaGe Linux Operations
Jan 14, 2022 · Frontend Development

Turn Any Text Editor into a Powerful Markdown Viewer with Markdeep

Markdeep is an open‑source JavaScript plugin that transforms plain‑text files into fully rendered Markdown documents—including tables, LaTeX math, and charts—without installing extensions, and can be used by simply adding a single line to any text editor, making offline, browser‑based publishing effortless.

JavaScriptMarkdownOpenSource
0 likes · 6 min read
Turn Any Text Editor into a Powerful Markdown Viewer with Markdeep
Taobao Frontend Technology
Taobao Frontend Technology
Jan 10, 2022 · Fundamentals

IceJS Electron Support, Haunted, Turborepo vs Nx, TypeScript Covariance

Today's roundup introduces IceJS's new Electron scaffold, warns about malicious code in faker.js and colors.js, showcases the upcoming Vue.js documentation, highlights the Haunted web‑components library, compares Turborepo with Nx, presents Microsoft’s lage task runner, and explains TypeScript covariance and contravariance concepts.

Electrondocumentationfrontend
0 likes · 6 min read
IceJS Electron Support, Haunted, Turborepo vs Nx, TypeScript Covariance
DeWu Technology
DeWu Technology
Dec 28, 2021 · Operations

Analysis and Improvement Strategies for Open Platform Integration and Technical Support

The DeWu Technical Support team, now covering most business domains, analyzed Open Platform integration pain points—unclear documentation, cumbersome audits, and limited self‑service tools—and responded by reorganizing the homepage, enhancing searchable docs, automating audit checks, and establishing a feedback loop to product, thereby cutting issue volume and speeding developer onboarding.

Audit EfficiencyDeveloper ExperienceOpen Platform
0 likes · 16 min read
Analysis and Improvement Strategies for Open Platform Integration and Technical Support
21CTO
21CTO
Dec 4, 2021 · Fundamentals

10 Essential Habits Every Programmer Should Master

This article outlines ten practical habits for developers, from relying on official documentation and thorough testing to effective logging, Git mastery, prioritizing functionality, handling ambiguous requirements, proactive problem‑solving, scheduling buffers, hands‑on learning, and improving English for better access to technical resources.

CareerGitLogging
0 likes · 8 min read
10 Essential Habits Every Programmer Should Master
Java Architecture Diary
Java Architecture Diary
Nov 30, 2021 · Backend Development

What’s New in Spring Boot 2.6.1? Key Bug Fixes and Docs Updates

Spring Boot 2.6.1, released on November 29, brings 11 bug fixes and documentation improvements to support the upcoming Spring Cloud 2021, addressing issues from pattern parsing to security filters, Lettuce integration, MockMvc configuration, and Elasticsearch dependency handling.

JavaSpring Bootdocumentation
0 likes · 3 min read
What’s New in Spring Boot 2.6.1? Key Bug Fixes and Docs Updates
MaGe Linux Operations
MaGe Linux Operations
Nov 7, 2021 · Fundamentals

Explore Python 3.10 Official Docs: Installation, API, FAQs & More

The Python 3.10.0 reference documentation provides a comprehensive guide covering installation, API reference, common questions, standard library details, language reference, and beginner tutorials, offering essential resources for newcomers and experienced developers alike, with downloadable PDFs and QR codes for easy access.

APIPythondocumentation
0 likes · 3 min read
Explore Python 3.10 Official Docs: Installation, API, FAQs & More
ByteFE
ByteFE
Oct 11, 2021 · Frontend Development

Understanding and Writing Effective Frontend Design Documents

This article explains what a frontend design document is, why it’s essential for reducing risk and improving efficiency, outlines the key elements and structure of a good document, and provides a practical template and example workflow for creating comprehensive design specifications in frontend development.

best-practicesdesign-documentdevelopment process
0 likes · 12 min read
Understanding and Writing Effective Frontend Design Documents
IT Architects Alliance
IT Architects Alliance
Sep 21, 2021 · Cloud Native

Improving Cluster Stability: CI/CD, Monitoring, Logging, Documentation, and Request Routing Solutions

The article analyzes the instability of a company's Kubernetes clusters, identifies root causes such as an unstable release process, lack of monitoring, logging, documentation, and unclear request routing, and proposes comprehensive solutions including a Kubernetes‑centric CI/CD pipeline, a federated Prometheus monitoring platform, an Elasticsearch logging system, a centralized documentation hub, and a unified traffic management architecture.

CI/CDLoggingdocumentation
0 likes · 8 min read
Improving Cluster Stability: CI/CD, Monitoring, Logging, Documentation, and Request Routing Solutions
Rare Earth Juejin Tech Community
Rare Earth Juejin Tech Community
Sep 16, 2021 · Mobile Development

Building a React Native Component Library with Lerna, Yarn Workspaces, and Automated Tooling

This tutorial walks through creating a production‑ready React Native UI component library named vant‑react‑native, covering monorepo setup with Lerna, package naming, Yarn workspaces, commit and code standards, icon generation, on‑demand loading, debugging, documentation with Dumi, CI/CD deployment, and unit testing.

BabelComponent LibraryLerna
0 likes · 24 min read
Building a React Native Component Library with Lerna, Yarn Workspaces, and Automated Tooling
FunTester
FunTester
Sep 10, 2021 · Backend Development

Insights and Pitfalls When Working with the Jira REST API

This article shares practical experiences and lessons learned while integrating with Jira's REST API, covering the absence of Chinese documentation, handling of HTTP status codes, inconsistent and overly nested JSON responses, demo errors, mixed language fields, and the differences between POST and PUT methods.

HTTPJiradocumentation
0 likes · 16 min read
Insights and Pitfalls When Working with the Jira REST API
21CTO
21CTO
Sep 9, 2021 · Fundamentals

Why Google’s Design Docs Can Transform Your Software Projects

This article explains Google’s design‑doc culture, detailing how informal yet structured documentation captures high‑level strategies, trade‑offs, and consensus, and outlines best‑practice sections, lifecycle steps, and when writing a design doc adds real value to software development.

best-practicesdesign docsdocumentation
0 likes · 15 min read
Why Google’s Design Docs Can Transform Your Software Projects
macrozheng
macrozheng
Sep 8, 2021 · Frontend Development

Build a Powerful Documentation Site with VuePress and Vdoing Theme

Learn how to create a feature‑rich, SEO‑friendly documentation website using VuePress and the Vdoing theme, covering installation, configuration, theme customization, content structuring, deployment, and tips for managing both structured and fragmented articles.

VdoingVuePressdeployment
0 likes · 15 min read
Build a Powerful Documentation Site with VuePress and Vdoing Theme
Top Architect
Top Architect
Sep 2, 2021 · Cloud Native

Designing a Stable Backend Architecture: CI/CD, Federated Monitoring, Logging, Documentation, and Traffic Management on Kubernetes

The article analyzes why a company's clusters were unstable—unstable release process, missing monitoring and logging, insufficient documentation, and unclear request routing—and proposes a comprehensive solution built around Kubernetes‑centric CI/CD, a federated Prometheus monitoring platform, Elasticsearch logging, centralized documentation, and Kong/Istio traffic management.

CI/CDCloud NativeLogging
0 likes · 9 min read
Designing a Stable Backend Architecture: CI/CD, Federated Monitoring, Logging, Documentation, and Traffic Management on Kubernetes
Tencent IMWeb Frontend Team
Tencent IMWeb Frontend Team
Aug 5, 2021 · Fundamentals

Why Markdown Beats Word for Modern Writing and Development

The article compares Microsoft Word's heavyweight rich‑text workflow with lightweight, readable Markdown, explains Markdown's history and standards, and recommends several Markdown‑friendly tools for writing, documentation, and front‑end development.

SoftwareRecommendationsWordWritingTools
0 likes · 9 min read
Why Markdown Beats Word for Modern Writing and Development
Alibaba Terminal Technology
Alibaba Terminal Technology
Jul 29, 2021 · R&D Management

How to Systematically Build and Manage Technical Products for Developers

This guide walks through a systematic approach to creating, designing, architecting, and operating technical products for developers, covering product design, architecture diagrams, project organization, Git workflows, documentation, CI/CD pipelines, collaboration mechanisms, and post‑release maintenance to help teams deliver successful developer‑focused tools.

CI/CDdocumentationopen source
0 likes · 22 min read
How to Systematically Build and Manage Technical Products for Developers
Taobao Frontend Technology
Taobao Frontend Technology
Jul 15, 2021 · Frontend Development

Building a Powerful Docs Site for a Front‑End Graphics Engine Using Gatsby

This article walks through the challenges and solutions of creating an integrated, searchable, multilingual documentation website for the Oasis Engine graphics engine, covering the selection of static site generators, the use of Gatsby with TypeDoc and GraphQL, custom plugins for embedding demos, and implementing global search with Algolia DocSearch.

GatsbyGraphQLTypeDoc
0 likes · 22 min read
Building a Powerful Docs Site for a Front‑End Graphics Engine Using Gatsby
DevOps
DevOps
Jul 13, 2021 · Product Management

Agile Documentation: Writing Value‑Driven Docs

The article explains what documentation means in agile development, why completely abandoning docs is harmful, and how to create documentation that truly adds value by applying the 5W1H framework, timing, stakeholder focus, and lean practices within Scrum teams.

5W1H@Valuedocumentation
0 likes · 14 min read
Agile Documentation: Writing Value‑Driven Docs
Laravel Tech Community
Laravel Tech Community
Jun 27, 2021 · Fundamentals

Markdown Introduction and Cheat Sheet

This article introduces Markdown, explains its popularity, and provides a comprehensive cheat sheet covering both standard and extended syntax, accompanied by visual examples to help readers quickly reference formatting rules for writing.

Cheat SheetMarkdowndocumentation
0 likes · 2 min read
Markdown Introduction and Cheat Sheet
ByteFE
ByteFE
Jun 23, 2021 · Frontend Development

Building an Effective Frontend Team in a Startup

This article discusses the challenges faced by frontend developers in startup companies and offers practical solutions such as coding standards, design guidelines, component libraries, documentation, project infrastructure, collaboration processes, and team culture to improve professionalism, coordination, and productivity.

coding standardscollaborationdesign system
0 likes · 15 min read
Building an Effective Frontend Team in a Startup
Xianyu Technology
Xianyu Technology
Jun 22, 2021 · Mobile Development

FlutterBoost 3.0 Preview Release: Enhanced Lifecycle Management and Documentation

FlutterBoost 3.0 preview, released after two months of development and testing, introduces refactored lifecycle management, enhanced cross‑platform consistency, custom startup and return parameters, page transparency, custom event handling, pre‑interceptors, and expanded documentation with examples, while maintaining the existing architecture and focusing on community adoption.

Cross-PlatformFlutterFlutterBoost
0 likes · 9 min read
FlutterBoost 3.0 Preview Release: Enhanced Lifecycle Management and Documentation
Qunhe Technology User Experience Design
Qunhe Technology User Experience Design
Jun 22, 2021 · Product Management

How to Build an Effective Design Acceptance Framework for Agile Teams

This article explains why designers need a dedicated design‑acceptance stage, compares waterfall and agile challenges, and introduces a systematic four‑phase framework—single‑feature, module, global, and periodic review—plus practical documentation standards to ensure high‑quality product delivery.

Product QualityUX processagile workflow
0 likes · 13 min read
How to Build an Effective Design Acceptance Framework for Agile Teams
Laravel Tech Community
Laravel Tech Community
Jun 20, 2021 · Backend Development

PHP cal_info Function: Returns Calendar Information

The cal_info() PHP function returns detailed information about a specified calendar—including month names, abbreviations, maximum days, and identifiers—or all supported calendars when no argument is given, with usage examples and output illustrated.

CalendarFunctionPHP
0 likes · 3 min read
PHP cal_info Function: Returns Calendar Information
21CTO
21CTO
Jun 14, 2021 · Backend Development

4 Must‑Have Non‑Functional Requirements for Secure, Documented APIs

Creating a robust API involves more than just making it work; developers must address four critical non‑functional aspects—security (HTTPS, CORS, JWT authentication, scopes), comprehensive documentation, thorough validation, and systematic testing—to ensure reliability, safety, and maintainability in production environments.

APIdocumentationsecurity
0 likes · 12 min read
4 Must‑Have Non‑Functional Requirements for Secure, Documented APIs
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.

GoogleMarkdownStyle Guide
0 likes · 12 min read
Google Technical Writing Course – Lesson 1: Core Principles and Practical Tips
Alibaba Cloud Developer
Alibaba Cloud Developer
Apr 19, 2021 · R&D Management

How to Turn Cross‑Team Tasks into Reliable Success: A Practical Guide

This article uses a real‑world example of a new developer tasked with creating project documentation to illustrate common pitfalls and offers a step‑by‑step framework for defining purpose, breaking work into manageable stages, coordinating teammates, tracking progress, and delivering tangible results that reinforce reliability and personal growth.

Task Managementdocumentationprocess design
0 likes · 10 min read
How to Turn Cross‑Team Tasks into Reliable Success: A Practical Guide
Alibaba Cloud Native
Alibaba Cloud Native
Apr 17, 2021 · Cloud Native

Step-by-Step Guide to Contribute KubeVela Documentation Translations

This guide explains why KubeVela documentation needs Chinese translation, outlines the community‑organized translation activity, and provides detailed preparation steps, task workflow, local build commands, PR submission, review process, and final merge instructions for contributors.

Cloud NativeDocusaurusGitHub
0 likes · 6 min read
Step-by-Step Guide to Contribute KubeVela Documentation Translations
MaGe Linux Operations
MaGe Linux Operations
Mar 26, 2021 · Fundamentals

Master Google Python Style Guide: Essential Coding Standards Explained

This comprehensive guide translates Google's Python style guide into clear English, covering everything from naming conventions and imports to docstrings, type annotations, and best practices for functions, classes, and modules, helping developers write clean, consistent, and maintainable Python code.

PythonStyle Guidecoding standards
0 likes · 55 min read
Master Google Python Style Guide: Essential Coding Standards Explained
phodal
phodal
Mar 22, 2021 · Industry Insights

Mastering Developer Experience: Key Principles, Metrics, and Best Practices

This article explores the concept of Developer Experience (DX), outlining its definition, essential conditions, practical examples, six core elements, measurement methods, and strategies for improvement, while highlighting why DX is crucial for modern software development and competitive advantage.

DXDeveloper Relationsdocumentation
0 likes · 15 min read
Mastering Developer Experience: Key Principles, Metrics, and Best Practices
ITPUB
ITPUB
Mar 15, 2021 · Fundamentals

How to Choose the Right Software Stack: A Practical Guide to Tech Selection

This article explains how business-driven requirements guide software selection, detailing how to identify research targets, evaluate system architecture, community health, documentation, compliance, and feature fit, and then verify through testing before applying the chosen solution.

documentationopen-source communitysoftware selection
0 likes · 10 min read
How to Choose the Right Software Stack: A Practical Guide to Tech Selection
Baidu App Technology
Baidu App Technology
Mar 12, 2021 · Frontend Development

Boost Your Frontend Projects: 9 Essential Practices for San CLI Maintenance

This guide shares nine practical techniques—including issue templates, code linting, unit testing, commit‑message enforcement, continuous integration, GitHub badges, npm‑package monitoring, changelog automation, and contribution guidelines—to help front‑end teams efficiently maintain and scale open‑source projects like San CLI.

CIGitHubdocumentation
0 likes · 26 min read
Boost Your Frontend Projects: 9 Essential Practices for San CLI Maintenance
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
Beike Product & Technology
Beike Product & Technology
Feb 23, 2021 · Frontend Development

Using Dumi for Component Library Development and Documentation

This article introduces Dumi, a tool that combines component library project scaffolding with static documentation site generation, explains its three project modes, code structure, MDX-based documentation editing, on‑demand loading, build configurations, workflow commands, and publishing steps for frontend developers.

Component LibraryMDXbuild
0 likes · 10 min read
Using Dumi for Component Library Development and Documentation
Liangxu Linux
Liangxu Linux
Feb 1, 2021 · Fundamentals

Mastering C/C++ Comment Standards: A Practical Guide

This guide explains why comments are essential for code readability, outlines various comment styles for C/C++—including file, function, variable, spelling, and TODO comments—and provides concrete examples and best‑practice recommendations to help developers write clear, maintainable code.

C++best practicescode comments
0 likes · 6 min read
Mastering C/C++ Comment Standards: A Practical Guide
ByteFE
ByteFE
Jan 24, 2021 · Frontend Development

2020 Web Development Research Roundup: Key Findings from Major Front‑End Surveys and Reports

This article aggregates and translates the major 2020 web‑development research—including MDN’s developer needs assessment, HTTP Archive’s state‑of‑the‑web, State of CSS, GitHub Octoverse, Stack Overflow, Angular, JetBrains, WebAIM, and numerous other surveys—to reveal trends in accessibility, documentation, CSS adoption, API usage, and developer satisfaction across the front‑end ecosystem.

2020 Trendsaccessibilitydeveloper ecosystem
0 likes · 19 min read
2020 Web Development Research Roundup: Key Findings from Major Front‑End Surveys and Reports
Laravel Tech Community
Laravel Tech Community
Jan 20, 2021 · Frontend Development

Bootstrap 4.6.0 Released with Major Updates and Migration to Hugo

Bootstrap 4.6.0 has been released, introducing customClass support for tooltips and popovers, a new .navbar-nav-scroll class for mobile navigation, accessibility improvements, updated documentation built on Hugo, darker dropdown items, better form‑validation tooltip alignment, and fixed file‑input overflow issues.

BootstrapHugoRelease
0 likes · 3 min read
Bootstrap 4.6.0 Released with Major Updates and Migration to Hugo
macrozheng
macrozheng
Jan 13, 2021 · Backend Development

Which Open‑Source API Documentation Tool Fits Your Needs? A Comparative Review

Facing the challenge of building an open API platform, the author evaluates several open‑source documentation generators—GitBook, smart‑doc, Redoc, Knife4j, YAPI, apidoc, and ShowDoc—detailing their licenses, language, stars, features, pros, cons, and suitability for real‑time online docs.

APIComparisondocumentation
0 likes · 13 min read
Which Open‑Source API Documentation Tool Fits Your Needs? A Comparative Review
Beike Product & Technology
Beike Product & Technology
Oct 29, 2020 · Frontend Development

Introduction to tocbot

tocbot is a JavaScript library that generates a table of contents from HTML content, allowing users to navigate documents easily with scrolling synchronization.

JavaScriptLibraryTable of Contents
0 likes · 7 min read
Introduction to tocbot
ITPUB
ITPUB
Oct 15, 2020 · Operations

How a Huawei Maintenance Engineer Turned Painful On‑Call Duty into Efficient Knowledge Management

A Huawei maintenance engineer shares a decade‑long journey of turning 24/7 on‑call pain into systematic knowledge management, building comprehensive fault‑handling documentation, automating tools, and guiding the team’s evolution toward SRE practices that dramatically reduce manual effort and improve reliability.

AutomationHuaweiKnowledge Management
0 likes · 14 min read
How a Huawei Maintenance Engineer Turned Painful On‑Call Duty into Efficient Knowledge Management
DevOps Engineer
DevOps Engineer
Sep 13, 2020 · Backend Development

How to Publish a Python Project on GitHub and PyPI: setup.py, Packaging, pydoc, Versioning, and License Selection

This guide explains how individuals or organizations can configure a setup.py file, build distribution packages, publish them to PyPI, generate documentation with pydoc, choose appropriate version numbers, and select a suitable open‑source license for a Python project hosted on GitHub.

documentationlicensepackaging
0 likes · 10 min read
How to Publish a Python Project on GitHub and PyPI: setup.py, Packaging, pydoc, Versioning, and License Selection
FunTester
FunTester
Jul 22, 2020 · Industry Insights

What Simple Validation Mistakes Reveal About Real‑World Testing

The author recounts bugs uncovered during a web‑based QA session—ranging from mismatched character‑length limits and inconsistent filter defaults to fragmented documentation—highlighting how overlooking tiny validation rules can cause costly defects and why unified standards and professional testing are essential.

bug fixingdocumentationquality assurance
0 likes · 5 min read
What Simple Validation Mistakes Reveal About Real‑World Testing
Top Architect
Top Architect
Jul 20, 2020 · Fundamentals

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

This article explains the value of technical diagramming, defines architecture and architecture diagrams, describes their purposes, outlines common diagram categories such as the 4+1 view, offers criteria for good diagrams, addresses typical pitfalls, and introduces the C4 model with concrete examples and a case study.

C4 modeldiagramdocumentation
0 likes · 10 min read
How to Create Effective Architecture Diagrams: Concepts, Types, and Best Practices
Laravel Tech Community
Laravel Tech Community
Jun 19, 2020 · Frontend Development

Bootstrap 5 Alpha Released: Major Changes and New Features

Bootstrap 5 Alpha introduces a jQuery‑free core, drops Internet Explorer support, revamps the documentation UI, adds CSS custom properties, expands the grid system and utilities, and brings numerous enhancements to forms, colors, and overall developer experience.

BootstrapJavaScriptcss
0 likes · 6 min read
Bootstrap 5 Alpha Released: Major Changes and New Features
FunTester
FunTester
Jun 2, 2020 · Backend Development

Efficient API Testing with Swagger and Springfox

This article explains how to use Swagger and Springfox to automate API documentation and testing in Java SpringBoot projects, covering the benefits of Swagger, integration steps, Maven dependencies, configuration examples, and how to access the generated interactive UI for faster, more reliable interface validation.

AutomationSwaggerbackend
0 likes · 8 min read
Efficient API Testing with Swagger and Springfox
Laravel Tech Community
Laravel Tech Community
May 19, 2020 · Backend Development

Laravel String Helper Cheat Sheet

This article provides a concise reference of Laravel's String helper functions, describing each method's purpose and showing example code snippets for common string operations such as conversion, case manipulation, searching, and generating random strings.

HelperLaravelPHP
0 likes · 2 min read
Laravel String Helper Cheat Sheet
21CTO
21CTO
May 12, 2020 · Fundamentals

Avoid These Common Programming Mistakes to Boost Code Quality

This article outlines frequent programming errors—such as trusting user input, skipping tests, neglecting documentation and logs, hard‑coding values, ignoring rest, and failing to keep learning—and offers practical advice to prevent them and improve software reliability.

code qualitydocumentationprogramming best practices
0 likes · 5 min read
Avoid These Common Programming Mistakes to Boost Code Quality
ITPUB
ITPUB
Apr 28, 2020 · Fundamentals

4 Essential Online Documentation Tools Every Developer Should Use

This guide explains why proper software documentation is crucial and reviews four popular online tools—GitHub Pages, Read the Docs, Tettra, and Apiary—detailing their features, how they integrate with version control, and where to access them.

GitHub Pagesapiarydocumentation
0 likes · 5 min read
4 Essential Online Documentation Tools Every Developer Should Use
Alibaba Cloud Developer
Alibaba Cloud Developer
Apr 24, 2020 · Frontend Development

How to Build and Maintain a Scalable Component Library for Micro‑Frontend Projects

This article explores the challenges of component maintenance in micro‑frontend architectures, compares different component types, and presents a practical CLI tool that automates scaffolding, testing, documentation, and publishing to streamline the creation of a reusable, well‑documented component library.

AutomationCLIComponent Library
0 likes · 17 min read
How to Build and Maintain a Scalable Component Library for Micro‑Frontend Projects
58 Tech
58 Tech
Apr 22, 2020 · Mobile Development

magpie_fly: An Open‑Source Flutter Component Library for Unified UI Development

The article introduces magpie_fly, an open‑source Flutter component library created by 58.com to unify component management, provide detailed documentation with live previews and source code, outline its implementation approach, list existing widgets, and describe future plans for community contributions.

Component LibraryFlutterMobile Development
0 likes · 10 min read
magpie_fly: An Open‑Source Flutter Component Library for Unified UI Development
政采云技术
政采云技术
Apr 19, 2020 · Frontend Development

Building a Real‑Time Editable Documentation Site with EggJS, Marked, Highlight.js and Docsify

This article describes how a front‑end team can create a markdown‑based documentation site that updates automatically via GitLab webhooks, using EggJS with marked and highlight.js for server‑side rendering or NestJS with docsify for client‑side rendering, and provides complete code examples and deployment steps.

DocsifyEggJSMarkdown
0 likes · 10 min read
Building a Real‑Time Editable Documentation Site with EggJS, Marked, Highlight.js and Docsify