25 lines
774 B
Markdown
25 lines
774 B
Markdown
|
||
手册书写规范：
|
||
1、前提条件
|
||
2、功能描述
|
||
3、入口（命令、快捷命令、快捷键)
|
||
4、操作及结果(菜单选择、功能按钮执行、弹窗处理，截图/动图及视频链接)。
|
||
5、特性参数与属性详解--通用参数与属性(链接)。
|
||
6、功能的应用-使用场景
|
||
7、注意事项说明。
|
||
|
||
|
||
vs编写规范
|
||
1、Manual-doc对应的二级模块目录下创建md文件（命名规则：功能名（时间年月+编写人名首字母缩写））
|
||
2、模块目录下PHOTO文件创建各自的图片文件（命名规则：功能名+编号）
|
||
3、md内容的标题简易易懂
|
||
4、审核人衍琴、庆炀、小玲，审核手册后，根据功能模块进行整合
|
||
|
||
|
||
本地调试部署
|
||
|
||
'npm run dm'
|
||
|
||
|
||
文件目录说明
|