From 28d7e583cf18afe7c125897204313bdcd280346f Mon Sep 17 00:00:00 2001 From: laiyq <583737117@qq.com> Date: Mon, 2 Feb 2026 15:12:50 +0800 Subject: [PATCH] =?UTF-8?q?2026.2.2lyq=E6=8F=90=E4=BA=A4=E8=8C=83=E6=96=87?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- FAQ/docs/Rules.md | 24 ++++++++++++++++++++++++ Manual/docs/README.md | 3 +++ README.md | 2 ++ 3 files changed, 29 insertions(+) create mode 100644 FAQ/docs/Rules.md diff --git a/FAQ/docs/Rules.md b/FAQ/docs/Rules.md new file mode 100644 index 0000000..b5cdf1e --- /dev/null +++ b/FAQ/docs/Rules.md @@ -0,0 +1,24 @@ + +手册书写规范: +1、前提条件 +2、功能描述 +3、入口(命令、快捷命令、快捷键) +4、操作及结果(菜单选择、功能按钮执行、弹窗处理,截图/动图及视频链接)。 +5、特性参数与属性详解--通用参数与属性(链接)。 +6、功能的应用-使用场景 +7、注意事项说明。 + + +vs编写规范 +1、Manual-doc对应的二级模块目录下创建md文件(命名规则:功能名(时间年月+编写人名首字母缩写)) +2、模块目录下PHOTO文件创建各自的图片文件(命名规则:功能名+编号) +3、md内容的标题简易易懂 +4、审核人衍琴、庆炀、小玲,审核手册后,根据功能模块进行整合 + + +本地调试部署 + +'npm run dm' + + +文件目录说明 diff --git a/Manual/docs/README.md b/Manual/docs/README.md index 7cbb77c..714fc8c 100644 --- a/Manual/docs/README.md +++ b/Manual/docs/README.md @@ -1,3 +1,6 @@ # 首页 这是手册默认首页,请添加自定义内容。 + + + diff --git a/README.md b/README.md index 4f7cefd..1fd600b 100644 --- a/README.md +++ b/README.md @@ -14,3 +14,5 @@ ``` > 关于图片插入与图片缩放: https://docsify.js.org/#/helpers?id=image-resizing + +