plantuml(2022-02-15)

         在我们平时在进行概要设计文档编写时需要编写模块分层图、流程图、类图、时序图、实施部署图，其中plantuml为一个很好的画图平台工具。

其链接为:https://www.swack.cn；

        这里面有示例Demo,自己在编写相关技术文档时，首先知道自己需要画什么样的图，然后顺便把自己的思维思想梳理下，最好在纸上简单的画出来，然后把自己的想法串联起来，形成整体脉络和贯通思想，然后就可以开始进行画图了。

        至于画各种图，其实可以找下其它类似图，然后套用其语法。

PlantUML是其中的一个模块，当然里面也有文档格式化工具:markdown,首先模块图:

1.模块分层图:

@startuml

node “web服务器” {

    [web server]

}

node “client 服务器” {

    [aaa server]

}

[web server] -- [aaa server]

node "客户端" {

[aaa server] -- [模块A]

[模块B]

}

node "刷写工具" {

    [Tool]

}

[模块A] -- [Tool]

[web server] -- [模块B]

@enduml

2.时序图

​

@startuml

厂商 -> 系统服务: 1. 开始激活(cmdTestDemo -run)
系统服务 -> 预生产后台服务: 2. 连接客户端服务器
系统服务 --> 预生产后台服务: 3. 上传硬件信息
系统服务 <- 预生产后台服务: 4. 下发许可信息
厂商 -> 系统服务 : 5. 激活工具
系统服务 -> 系统服务 : 6. 心跳触发
alt false: 7. 无网
    系统服务-> 系统服务: 7.a 保持预激活状态
else 有网
    系统服务 -> 系统服务: 7.b 读取表数据,进行完整性校验
    alt true: 校验成功
        系统服务 -> 后台服务: 7.b.1 开始服务注册
    else 系统校验失败
        系统服务-> 系统服务: 7.b.2 保持预激活状态
    end
end
厂商 <- 系统服务: 8. 激活完成

@enduml
 

​

 3.部署实施图:

@startuml
package "**制作OEM镜像**" {
start
:系统基础镜像;
:写入相关脚本;
note left
    安装阶段执行脚本:1.job
    脚本流程:
    1.one
    2.two
    3.three
    ----
    审核模式阶段执行脚本:2.job
    脚本流程:
    1.one
    2.two
end note
:定制OEM系统镜像;
}

package "**system install and activate**" {
    :安装系统镜像;
note left
    系统会按照脚本序号和顺序执行安装工作
end note
    if (执行1.job) then (成功)
    :系统安装成功(信息写入BIOS);
    :系统重启，并进入审核模式;

        if (执行2.job) then (成功)
        :激活成功;
        else (失败)
        :激活失败;
        endif

    else (失败)
    :安装失败;
    endif
}
stop

@enduml