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.
This guide walks developers through selecting VuePress for a centralized documentation portal, installing it globally or locally, configuring navigation and build scripts, generating static files, deploying them on an Ubuntu server with Nginx, and automating updates via Jenkins, cron jobs, and Docker.
This tutorial provides a comprehensive overview of Markdown syntax, covering heading levels, text styling, unordered and ordered lists, blockquotes, inline and fenced code blocks, tables, horizontal rules, as well as link and image formatting, with clear examples for each feature.
This article outlines comprehensive IT operations practices, covering methods, documentation, process flows, essential technical skills, monitoring strategies, backup solutions, and the overall value of operations in supporting business objectives.
This article explores why API design is crucial for large‑scale software systems, outlines fundamental design principles, presents detailed best‑practice recommendations, and discusses compatibility, idempotency, error handling, and versioning with concrete examples such as the POSIX File API.
This article chronicles the author’s journey from fragmented knowledge‑base tools to adopting MDWiki—a pure front‑end, Markdown‑driven wiki that can be deployed on any web server, integrated with GitHub Pages, and extended with comments, analytics, and custom build pipelines.
This article explores the multifaceted role of IT operations, emphasizing how automation, documentation, processes, monitoring, and backup strategies create business value, and shares practical insights from over ten years of experience to help professionals elevate their operational impact.
Taro UI is a multi‑end UI component library built by the Aotu Lab, offering easy installation, rich components, and seamless adaptation across WeChat mini‑programs, H5, and ReactNative, with detailed quick‑start instructions and code examples for developers.
This guide walks you through the essential parts of a Laravel codebase—documentation, composer files, routes, service providers, tests, and debugging tools—so you can confidently understand and contribute to a new project even without prior PHP experience.
This article explains how to use Python’s built‑in help() function to view documentation for modules, objects, and keywords, shows the command syntax, provides interactive examples, demonstrates how to browse modules, keywords and topics, and describes the simple “q” key method to exit the help session.
Understanding and documenting the system context—its external users, roles, channels, and interacting systems—provides a foundational view that links business context to architecture, guides information flow modeling, and ensures traceability throughout the software development lifecycle.
This article explains the discipline of software architecture, its historical roots, key definitions, the importance of comprehensive documentation, various architectural views, and essential documentation components that help teams communicate designs, educate new members, and maintain system quality over time.
VuePress is a lightweight static site generator for technical documentation and blogs that offers responsive design, theme customization, Markdown with Vue components, PWA support, and easy navigation configuration, and can be quickly set up, built, and deployed via simple npm or Yarn scripts while handling common pitfalls such as asset placement and base‑path adjustments.
The article shares practical QA techniques and project‑progress strategies for a mobile DSP advertising team, emphasizing paper‑based documentation, rapid test case execution, clear test design using XMind, and the potential of AI‑driven bug analysis, while also highlighting the importance of versatile testing roles.
This guide shares practical GitHub usage habits, from crafting consistent READMEs and issue/PR templates to leveraging labels, CI integration, release workflows, and post‑release support, helping open‑source maintainers improve project visibility, collaboration, and quality.
This article compares traditional waterfall and agile software architecture, examining the roles, timelines, and deliverables of architects, sharing real‑world challenges, and offering practical guidelines for building sustainable, adaptable architectures in modern development teams.
This article chronicles the development of a DevOps documentation hub from its early v0.5 prototype through v1.0 and v2.0 releases, detailing the shift from reStructuredText to Markdown, the use of Git submodules, Azure App Service deployment, and plans for automated navigation and community interaction.
This article explains how Electron lets web developers create cross‑platform desktop applications with familiar JavaScript and Node.js, compares it to NW.js, outlines learning stages, offers documentation tips, and provides guidance on selecting and extending useful demo projects.
This article highlights the most common Linux frustrations in 2017, from inadequate documentation and software version incompatibilities to UEFI/Secure Boot challenges, the decline of 32‑bit support, and deteriorating X‑forwarding support, while noting overall progress and inviting readers to share their own issues.
This article explains the concept of custom schema URLs in mobile development, describes the problems of a growing ad‑hoc implementation, and presents a refactored, configuration‑driven architecture that provides automatic matching, self‑documenting schemas, and integrated testing for Android apps.
This article outlines a comprehensive R&D management framework covering product lifecycle‑based task planning, documentation practices, code collaboration, quality assurance, automated deployment, fault handling, instant communication, and techniques for boosting team technical competence.
This article presents a detailed, experience‑driven guide to building an efficient R&D management system covering the product lifecycle, task management, documentation, code collaboration, quality assurance, automated deployment, fault management, instant communication, and techniques for continuous technical improvement.
The article explains how integrating chatbots into communication platforms like Slack transforms routine operations into transparent, collaborative, and mobile-friendly workflows, enabling continuous pair‑programming, on‑the‑fly documentation, focused incident response, and seamless cross‑team coordination.
This guide compiles sixteen highly useful websites—including search engines, official documentation, Chinese tutorials, community Q&A, and framework references—to help anyone learning Python find reliable resources and solve programming problems efficiently.
This article shares ten practical guidelines—from clear naming and solid modeling to robust exception handling, elegant design, strong fundamentals, effective documentation, and a positive mindset—aimed at helping developers create software that is both functional and visually appealing while advancing their careers.
The article shares practical operations lessons—from periodic permission audits and thorough documentation to capacity monitoring, log rotation, and automation—illustrating how systematic practices and tooling can standardize and streamline IT infrastructure management.
This article explains why comprehensive interaction design documents are essential for aligning product vision, improving hand‑off accuracy, and boosting team efficiency, and it provides a detailed framework covering structure, layout, color, typography, and content guidelines to help design teams create clear, reusable documentation.
This article introduces three key macOS tools—Dash for documentation, MindNode for mind mapping, and OmniGraffle for diagramming—explaining their core features, usage tips, and how they can boost a developer's productivity, followed by a curated list of additional handy utilities.
This article describes how to build an automated documentation publishing pipeline using VSTS CI, Azure FTP deployment, Sphinx conversion, Docker containers, and GitHub synchronization, enabling one‑click HTML generation and backup for Markdown/reStructuredText sources.
Transpedia, launched with TDH 4.6, consolidates all StarRing product manuals into a single online portal that offers real‑time synchronization, keyword search, and intuitive navigation, eliminating the need for PDF downloads and dramatically improving documentation accessibility and user experience.
Effective API design requires shifting from a developer‑centric mindset to the user’s perspective, emphasizing clear documentation, stability, versioning, flexibility, security, and ease of use, while avoiding unnecessary complexity and ensuring consistent, well‑structured interfaces for diverse clients across web, mobile, and IoT platforms.
This article compares waterfall and agile approaches to software architecture, examining the architect's role, time span, deliverables, and documentation practices, and offers practical guidance for building sustainable, adaptable system designs in modern development environments.
This guide walks you through installing Sphinx, configuring the Read the Docs theme, generating reStructuredText from Python code, and building HTML documentation for your API, complete with project setup, conf.py tweaks, and custom module directives.
This article explains why APIs are valuable assets, outlines the essential traits of a good API, and provides a step‑by‑step design process—including requirements gathering, naming, documentation, performance considerations, exception handling, and refactoring examples—illustrated with Java code snippets.
This article explores the challenges of software documentation, proposes automated solutions using DevOps principles, and reviews tools that generate docs from code comments, manage versioned design documents, and integrate testing, offering practical guidance for teams to streamline documentation and improve development efficiency.
This article explains the definition of operational standardization and outlines four core principles—best practice, modularity, templating, and simplicity—showing how they improve team efficiency, documentation consistency, and enable scalable, automated operations.
This article outlines four key practices—comprehensive engineering documentation, robust business backup, continuous online monitoring, and regular periodic inspections—that together ensure optimal performance, reliability, and long‑term benefits for data center operations.
After two years as an intern and eight months as a full‑time engineer at Microsoft Azure, I reflect on nine often‑overlooked corporate practices—from missing documentation and low enthusiasm to limited code review and reliance on outdated tools—that shape daily life for developers in large tech firms.
