docs: migrate documents from Notion

This commit is contained in:
siujamo
2026-05-21 01:53:46 -05:00
parent c7b623012c
commit 0295b758fd
39 changed files with 3292 additions and 4 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.