我们有一个过去7个月开发的“网络应用程序”。问题是，它没有真正记录。这些要求包括7个月前初次会议的一个小项目符号列表（它更多的是“目标”声明，而不是软件要求）。它收集了许多源于小型口头或聊天讨论的功能。
开发商很快就要离开了。他自己写了整个事情，他知道每个页面的所有怪癖和基本规则，但没有其他人真正了解它的用户界面;这当然是最简单的部分，因为它对用户来说是直观的。但如果有人需要修复或添加功能，整个事情就是黑盒子。代码有一些最小的注释，当然，Web应用程序的好处是地址栏指向正确的方向来解决问题或升级页面。
但是开发人员应该如何记录这个Web应用程序呢？他有点迷失到哪里开始。作为开发人员，如何为其他开发人员，维护人员和管理级用户完整地记录您的Web应用程序？您使用什么方法，从哪里开始，使用什么软件，是否有模板？
一个大小的想法：它使用PHP，MySQL和jQuery。它有大约20-30个主要（前端）文件，以及大约15个包含的文件和一些资产的几个文件夹 - 所以总体来说它是一个非常小的应用程序。它与7个MySQL表接口，每个表都有很好的名称，所以我认为数据库端是非常明显的。有一个config.inc.php文件，其中包含MySQL用户详细信息，一些来自/到电子邮件以及PHP用于插入电子邮件和页面（相对和绝对路径，基本上）的URL等定义。通过jQuery有一些AJAX。
请评论是否有任何其他信息可以帮助您，我很乐意对其进行编辑。
开发商周五离开。但是，他可以将剩余24小时的大部分时间用于此文档任务。所以，是的，事情是惨淡的，但24小时是相当多的......对吗？ ： - \
答案 0 :(得分：4)
首先列出应用程序当前实现的主要功能（更新初始项目符号）。
然后，对于每个项目符号点，记下与该项目符号点相关的主要要求。
对于每个要求，请记下：
这将为您提供可追溯性层次结构
功能=＆gt;要求=＆gt;实施
它还将提供一个良好的框架来挤压记忆并写下记录。
然后，评论每个php和inc页面。
从标题开始，概述目的以及满足上一个列表中的哪些要求（从代码到要求的反向可追溯性）。
浏览每个php / inc文件并评论主要操作/决策/循环，指出他们要完成的任务以及所假设的任何设计注意事项（例如“假设输入已在上一步中验证过”）。
在评论源代码时，您可能希望使用PHPDoc之类的工具，以便您可以从评论中生成文档。
答案 1 :(得分：4)
一种方法可能是安排一系列移交会议。在这些中，开发人员必须解释每个部分的代码。
他可以写一些笔记来准备这些，但让其他开发人员花费几分钟也可以帮助他们理解代码。这些会议也是一个提出有关不明确方面的问题的机会。
不要试图一次性完成整个网站。将它分解成两个较小的块，按功能或按区域分组。这意味着您的其他开发人员不会一次性受到过多信息的轰炸，原始开发人员可以集中精力在一个区域，并且您有机会在会议后跟进。
即使没有任何“直接”支持，当您稍后再访问该网站时，也会对该网站有所了解。
另一种方法可能是开发人员在网站上提供一系列简短的演示文稿及其构建方式。这可能会促使他记住他为什么采取他所做的方法。在查看代码时，这是非常宝贵的。如果你知道它试图解决什么问题，那就更容易理解了。