关于软件文档写作

Survive by day and develop by night.
talk for import biz , show your perfect code,full busy，skip hardness,make a better result,wait for change,challenge Survive.
happy for hardess to solve denpendies.

目录

概述

文档写作是一个非常常见的需求。

需求：

设计思路

实现思路分析

1.业务逻辑

业务逻辑是核心，只有搞懂了业务逻辑才是重点。对一个项目而言，需求才是最基本的。最好的方法就是对着需求看代码测试，写手册。

2.代码表达

代码表达，最直观的就是代码了，不再赘述。

3.形式归纳

主要是体现软件工程中的图，其实就是如何就是代码分析，

java-tracer，时序图，但是常用通常画流程图。这块适合小系统

4.方式和工具

word,Excel,pdf,md 都可以
VS，startUML,JUDE 都可以

参考资料和推荐阅读

[1]. https://blog.csdn.net/qq_35423190/article/details/125069834
[2].https://blessing.blog.csdn.net/article/details/126795316?spm=1001.2101.3001.6650.2&utm_medium=distribute.pc_relevant.none-task-blog-2%7Edefault%7ECTRLIST%7ERate-2-126795316-blog-8281192.pc_relevant_multi_platform_whitelistv3&depth_1-utm_source=distribute.pc_relevant.none-task-blog-2%7Edefault%7ECTRLIST%7ERate-2-126795316-blog-8281192.pc_relevant_multi_platform_whitelistv3&utm_relevant_index=3
[3].https://blog.csdn.net/heyl163_/article/details/127674790

欢迎阅读，各位老铁，如果对你有帮助，点个赞加个关注呗！~