refactor: re-organise doc structure

2026-05-22 11:48:09 +08:00
parent 54ecd30a98
commit 806ebd4cb6
49 changed files with 22 additions and 8 deletions
@@ -0,0 +1,26 @@
+---
+title: General Application Development Standards
+tags:
+  - standards
+  - best-practice
+  - engineering
+author:
+  name: Zihlu Wang
+  email: real@zihluwang.me
+---
+
+## Introduction
+
+This document outlines coding standards and best practices for application development. Adhering to these guidelines
+ensures code quality, maintainability, and consistency across all projects.
+
+## General Principles
+
+- **Clarity & Readability**: Code must be easy to read and understand. Prefer clear, self-documenting code over clever,
+  terse, but obscure solutions.
+- **Consistency**: Maintain a consistent coding style, naming conventions, and architectural patterns across the
+  project.
+- **Modularity**: Design components with loose coupling and high cohesion to promote reusability and simpler testing.
+- **Testability**: Write code that is inherently testable.
+- **Security-First Design**: Incorporate security considerations at every stage of development.
+- **Performance Awareness**: Be mindful of performance implications for critical code paths and API endpoints.