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.
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.
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.
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.
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.
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.
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.
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.
This article explains how well‑structured interaction documents—targeted at designers, front‑end and product teams—enhance collaboration efficiency by clarifying purpose, applying a clear hierarchy, focusing on essential details, and using practical tools such as user task flow diagrams.
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.
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.
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.
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.
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.
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.
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.
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.
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.
This article presents a four‑step framework—why the copy is needed, how to develop it, the deliverables, and implementation—to create and apply B‑segment copywriting standards that ensure consistent, effective communication for B2B products.
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.
This tutorial demonstrates how to install and use the Typer library to create Python command‑line interfaces with functions, subcommands, auto‑completion, and auto‑generated documentation, providing step‑by‑step code examples and usage instructions for developers.
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.
This guide explains how to write effective GoDoc by installing and using the godoc and pkgsite tools, applying proper comment syntax, handling package overviews, deprecation notices, and example tests, and publishing documentation on pkg.go.dev with badges, illustrated through the go.jsonvalue library.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Markdeep is an open‑source JavaScript plugin that turns any plain‑text file into a fully rendered Markdown document with support for tables, LaTeX equations, charts and even PPT‑style slides, requiring only a single markup line and no additional installations.
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.
This article explains how to build an iOS private library by extracting document_apis from the SDK using the lzfse compression method and the Dash documentation tool, detailing file paths, database structures, and parsing techniques for API metadata.
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.
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.
The article explains the PHP function apache_get_modules(), which takes no arguments and returns an array of the Apache modules currently loaded, and includes a sample code snippet demonstrating its usage for developers.
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.
This article examines how languages like Rust, Julia, Dart, Kotlin, and Swift implement documentation tools based on Markdown, adding custom syntax, testing capabilities, and extensible DSL features to create reliable, executable documentation ecosystems.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
This article explains how concise yet valuable project documentation—README, architecture, and API docs—helps developers onboard quickly, understand system design, and maintain long‑term project health, while offering practical content guidelines and real‑world examples.
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.
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.
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.
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.
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.
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.
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.
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.
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.
This article explains why comments are essential for code readability, outlines consistent comment styles, details file, function, variable, spelling, and TODO annotations, and provides practical examples to help developers write clear, maintainable C/C++ documentation.
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.
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.
The article examines common problematic comment styles—such as embedding contact info, design details, "how" instead of "why", usage instructions, and algorithm explanations—and suggests modern Git‑based practices to keep code clean and maintainable.
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.
This article outlines the key additions in Python 3.9 over 3.8, summarizes the concise language reference, standard library guide, installation tips, common FAQs, and provides official documentation links and a QR‑code method to download the full PDF.
This article explains why clear, standardized commit messages are essential for efficient code review, outlines the recommended three‑part structure (subject, body, footer), defines type and scope conventions, and provides practical examples and scripts for generating changelogs and handling revert commits.
tocbot is a JavaScript library that generates a table of contents from HTML content, allowing users to navigate documents easily with scrolling synchronization.
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.
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.
This article introduces a self‑implemented Swagger UI built on think‑vuele, explains its architecture and dependencies, provides step‑by‑step usage instructions and Maven integration, and details performance optimizations such as API summary loading, mock data generation, and customizable request headers.
The author reflects on personal experiences with agile adoption, emphasizing the importance of documentation, distinguishing true teams from loosely organized groups, clarifying Scrum role requirements, and discussing the unique challenges and advantages small teams face when practicing agile methodologies.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
This article shares Ant Design’s multi‑year open‑source project operation experience, covering project documentation, website setup, code style, unit testing, CI services, release workflow, issue/PR templates, Git tips and community‑driven growth strategies for a frontend UI library.
This tutorial explains how to install Node.js and docsify-cli, initialize a docsify project, customize the navigation bar, cover page, search and code highlighting, and finally deploy the documentation site to GitHub Pages or a cloud server using Nginx, while providing troubleshooting tips.
This guide walks you through downloading, extracting, and configuring C++ library man pages on a Linux system so that the standard "man" command can provide offline documentation for C++ functions and classes.
The article argues that no company can be genuinely technology‑driven, explaining that market demand, product focus, and solid management practices—not flashy tech—determine success, while also offering practical advice on documentation, soft skills, and realistic career expectations for developers.
This guide walks you through using Docsify to create a lightweight, dynamic documentation website for the SpringBoot-based mall project, covering installation, project initialization, sidebar and navigation customization, search, code highlighting, copy‑code features, and deployment via GitHub Pages.
Learn how to boost your workflow on GitHub by editing files directly, pasting images, formatting code blocks, linking issues and code, creating permanent permalinks, using project boards, setting up GitHub Wiki, deploying sites with Jekyll, and even turning the platform into a lightweight CMS.
Vant 2.0 launches with four new components, revamped documentation, enhanced theming and a slimmer bundle, while boasting 220 releases, a 98% issue‑resolution rate and plans for VantWeapp 1.0 and a Vue 3‑based Vant 3.0, reflecting the project’s marathon‑like, fast‑iteration development.
This article examines the debate over writing documentation in agile projects, explains how to create effective agile documentation using user stories, compares it with traditional project documentation, and offers concrete guidance and examples to help teams adopt a more efficient, value‑driven documentation approach.
This article explains why agile projects treat documentation differently from traditional projects, outlines the logical and structural differences, shows how to write user stories that pair Why and What, and provides practical guidance for creating concise, value‑driven agile documentation.
