支持应用程序时哪些文档有用?

时间:2010-05-31 23:46:52

标签: documentation

我将很快从这里的开发人员那里接手。因此,我将支持他在过去几年中撰写的所有申请。

我的问题是,在支持您可能不太了解的应用程序时,哪种文档最有助于处理如何解决问题,扩展功能,修改功能等?我想它需要概述软件的功能,它与其他软件的接口,使用的数据库,用户名,密码等等。

是否有软件支持文件这样的东西?引用任何模板都会非常有用。

不幸的是,BTW没有要求文件,规格等!所以,真的我的问题是,如果我的同事有一天为每个应用程序编写一个文档,以便我可以(更容易)支持它,那个文档会是什么样和/或它会是什么样的?

1 个答案:

答案 0 :(得分:1)

我主要询问某种应用程序运行方式的流程图/架构。

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

所以要做一个快速的文本模型:


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

<强>的index.php: 有登录框。提交登录到login.php

<强>的login.php: 使用数据库条目验证数据,在失败时显示错误或发送到Dashboard.php

<强> Dashboard.php: 登录后,这将充当主菜单


沿着这些方向的东西?对于基本文档,我认为这是要走的路。

希望这会有所帮助。祝你好运!