Documentation 支持应用程序时，哪些文档是有用的？

我很快就要从一个开发者那里接手工作了。因此，我将支持他在过去几年中编写的所有应用程序

我的问题是，在支持一个您可能不太了解的应用程序时，哪种文档对处理如何修复问题、扩展功能、修改功能等最有帮助？我认为它需要给你一个关于软件功能的概述，它与其他软件的接口，它使用的数据库，用户名，密码等等

有软件支持文档这样的东西吗？推荐任何模板都会非常有用

---

顺便说一句，不幸的是，没有需求文档、规范等！所以，实际上我的问题是，如果我的同事有一天为每个应用程序编写一个文档，这样我就可以（更容易地）支持它，那么该文档是什么和/或它看起来是什么样子呢？

我主要会问一些关于应用程序运行方式的流程图/模式

我希望能够知道每个文件如何与其他文件（以及数据库）交互。这样，您就知道从哪里开始修复bug或添加新功能，等等

因此，要对其进行快速的文本模拟：

---

Index.php->Login.php->Dashboard.php

Index.php: 有一个登录框。将登录提交到login.php

Login.php: 使用数据库条目验证数据，失败时显示错误或发送到Dashboard.php

Dashboard.php: 登录后，此功能将作为主菜单

---

类似这样的东西？对于基本文档，我认为这是一种方法

---

希望这有帮助。祝你好运

我主要要求提供一些应用程序运行方式的流程图/模式

我希望能够知道每个文件如何与其他文件（以及数据库）交互。这样，您就知道从哪里开始修复bug或添加新功能，等等

因此，要对其进行快速的文本模拟：

---

Index.php->Login.php->Dashboard.php

Index.php: 有一个登录框。将登录提交到login.php

Login.php: 使用数据库条目验证数据，失败时显示错误或发送到Dashboard.php

Dashboard.php: 登录后，此功能将作为主菜单

---

类似这样的东西？对于基本文档，我认为这是一种方法

希望这有帮助。祝你好运