门户维护文件

时间:2010-01-21 11:47:54

标签: project-management

我们外包了一个基于网络的门户,现在我们没有兴趣与他们合作,因为该网站日益变得越来越多,客户越来越多抱怨。

我们根据当地声誉选择了不同的团队,他们的投资组合很好地满足了我们的迫切需求。我们与他们讨论了这个项目,并在一周内他们提出了一些有助于我们控制的好主意。我们同意将这个项目授予他们。在过渡期间我在想什么:

您认为哪些文档可以帮助新开发人员理解该应用程序?我可以向他们索取多少种文件?如果新开发人员开始研究这些文档,那么这些文档可以帮助他们轻松理解所有方面(应用程序,数据库,配置等)

该应用程序在ASP.NET和SQL SERVER 2005上,并且所有无源控制工具中最可怕的部分就在那里。他们甚至没有按下发布按钮就可以直接进行部署。触摸运气:(

感谢。

2 个答案:

答案 0 :(得分:2)

在不知道它是什么类型的门户网站的情况下,这很难回答,但想到的是:

  • 使用说明书:功能描述,使用的技术,所涉及的所有机器和服务的完整概述(不要忘记数据库)

  • 备份:备份数据的方式和位置,以及在发生崩溃时从何处恢复数据

  • 所有使用的数据库的描述,表之间的关系,至少快速了解哪些数据存储在哪里

  • 指向管理界面,工具和脚本的任何和所有URL的链接

  • 日常操作:需要经常运行哪些cron作业,是否有缓存,文件列表或其他需要经常处理的事情

  • 确保所有使用的域名都属于您并且在您的控制之下

  • 项目文件结构的描述(哪个部分在哪里; API在哪里;视觉元素在哪里;前控制器在哪里)

  • 如何更改网站的视觉元素(样式表,表格,模板......)

  • 系统各个部分中发生的任何和所有URL重写操作的说明,以及它们指向的位置

  • 使用哪个Google Analytics / Google网站管理员帐户以及如何获取该帐户

  • 理想情况下,API文档和完整的phpDoc样式源代码文档

答案 1 :(得分:1)

除了@Pekka的好答案,我还要添加以下内容

  • 功能设计文件(或 业务要求) - 一个 解释应用程序应该如何 从商业角度出发。
  • 技术规范(或 架构文档) - 一个 解释了应用程序的用途 从技术发展而来 透视。
  • 应用程序支持 指南 - 某种形式的备忘单 解释常见问题,服务 帐户,批量计划等...

除文档外,您还应了解事件趋势;

  • 怎么可能发生事故?
  • 多久一次?
  • 他们需要多长时间才能解决?
  • 有多少已知缺陷?
  • 谁维护基础设施(修补操作系统,安全审核等)

如果您没有足够的技术资源来支付每日事件数量(请记住,当门户网站的使用率很高时可能存在高峰期),那么您可能会发现自己处于与当前服务相同的状态提供商。