跳到主要内容

整理原则

本知识库的写法与结构约定，方便未来的自己（和他人）快速理解与维护。

定位​

  • 体系化：有目录、有层级，避免只有零散链接
  • 可迭代：允许草案，用 front matter 或文首标注成熟度
  • 可串联：概念文之间互相链接，形成阅读路径

单篇结构建议​

  1. 一句话结论：这篇解决什么问题
  2. 背景与动机：为什么值得记
  3. 主体：分节阐述，配示意图或公式（如需）
  4. 参考与延伸：书籍、论文、外部链接

代码示例格式​

正文里行内用 `npm install`；多行代码使用围栏并可选标题（macOS 风格代码框）：

终端
npm run start:clean
示例.ts
const greeting = 'ABCreatoris Knowledge';
console.log(greeting);

命名与存放​

  • 文件放在对应领域目录下，文件名用小写与连字符
  • 专题系列可用子目录，例如 software-development/architecture/
  • 中英文：默认中文正文，重要页面在 i18n/en/ 提供英文版

协作​

仓库公开，欢迎通过 Issue 或 PR 指出错误或补充参考。大幅改写请先讨论方向，避免与既有结构冲突。