Skip to main content

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​

  1. One-line takeaway: what problem this page solves
  2. Context & motivation: why it’s worth writing down
  3. Body: sections, with diagrams or formulas as needed
  4. References & further reading: books, papers, external links

Code example format​

Use inline `npm install` in prose; multi-line blocks with optional titles (macOS-style code boxes):

Terminal
npm run start:clean
example.ts
const greeting = 'ABCreatoris Knowledge';
console.log(greeting);

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/docusaurus-plugin-content-docs/current/

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.