Writing principles
Conventions for how this knowledge base is written and structured—so future you (and others) can understand and maintain it quickly.
Purpose
- Systematic: clear hierarchy and navigation, not scattered links
- Iterable: drafts are fine; mark maturity in front matter or at the top when useful
- Connected: link concepts into reading paths
Suggested page shape
- One-line takeaway: what problem this page solves
- Context & motivation: why it’s worth writing down
- Body: sections, with diagrams or formulas as needed
- References & further reading: books, papers, external links
Naming & placement
- Files live under the matching domain; lowercase hyphenated names
- Series can use subfolders, e.g.
software-development/architecture/ - Default language is Chinese; important pages also under
i18n/en/
Collaboration
The repo is public. Issues and PRs are welcome for corrections and references. Large rewrites are better discussed first to avoid conflicting with the existing structure.