# neatlogic-document-online

**Repository Path**: neat-logic/neatlogic-document-online

## Basic Information

- **Project Name**: neatlogic-document-online
- **Description**: 在线帮助文档
- **Primary Language**: 其他
- **License**: AGPL-3.0
- **Default Branch**: develop3.0.0
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 15
- **Created**: 2023-08-10
- **Last Updated**: 2025-08-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 在线帮助文档
下面以“模型管理”为例，讲解维护文档的基本规则。

## 维护路径
所有文档所在路径：<br>
..\neatlogic-document-online\src\main\resources\neatlogic\resources\documentonline\zh

一个模块对应一个文件目录，如配置管理模块的文档都在“3.配置管理”的目录下。
![](src/main/resources/neatlogic/resources/documentonline/zh/100.系统配置/README_IMAGES/模块目录.png)

## 文档和附件
每个模块下面会有文档的分类目录，比如目录“模块管理”，目录下包含了帮助文档和引用图片目录，说明如下。

- 帮助文档是markdown类型文件
- 同级别的目录和帮助文档命名时，可以用“数字+.”作为前缀，控制排序，
- 文档和图片目录同级
- 图片命名规范，“帮助文档名称_后缀”，示例如下
  ![](src/main/resources/neatlogic/resources/documentonline/zh/100.系统配置/README_IMAGES/附件命名规范.png)