projectrules.ai

学习笔记生成规范

DocumentationUMLMarkdownFile NamingDirectory Structure

Description

学习笔记生成规范

Globs

**/*
---
description: 学习笔记生成规范
globs: **/*
---

# 学习笔记生成规范

- 当我说画一个 uml 图,请使用 plantuml 格式来生成 puml 文件
    - 请结合笔记的内容给文件取个好理解的名字
    - 文件的名字请用英文名
    - 生成的文件放在 doc 或者 docs 目录下
- 当我说写/生成一份笔记的时候,请使用markdown的格式生成 md 文件
    - 请结合笔记的内容给文件取个好理解的名字
    - 文件的名字请用英文名
    - 如果你觉得某些章节可以用 uml 图来辅助理解, 可以帮我生成 uml 图, 在对应章节引用这个 uml 图文件
    - 给笔记生成目录,方便索引