In addition to @Pekka's good answer I'd add the following
Functional Design Document (or Business Requirements) - One that explains how the application should work from a business perspective.
Technical Specification (or Architecture document) - One that explains how the application was developed from a technical perspective.
Application Support Guide - Some form of cheat sheet that explains the common problems, service accounts, batch schedules... etc
In addition to documentation you should be aware of the incident trends;
How may incidents?
How often?
How long do they take to resolve?
How many known defects are there?
Who maintains the infrastructure (patching OS, security audits, etc)
If you don't have enough technical resources to cover the daily number of incidents (keeping in mind there might be peak periods when usage of the portal is high) then you will probably find yourself in the same situation as your current service provider.
发布评论
评论(2)
如果不知道它是什么类型的门户,就很难回答这个问题,但我会想到什么:
用户手册:功能描述、所使用的技术、所涉及的所有机器和服务的完整概述(不要忘记数据库)
备份:数据备份的方式和地点,以及从何处恢复数据崩溃的
使用的所有数据库的描述,表之间的关系,至少快速了解哪些数据存储在何处
链接到管理界面、工具和脚本的任何和所有 URL
日常操作:哪些 cron 作业需要经常运行,是否有缓存、文件列表或其他需要经常处理的事情
确保使用的所有域都属于您并在您的控制之下
项目文件结构的描述(哪个部分在哪里; API 在哪里;视觉元素在哪里?前端控制器在哪里)
如何更改的方法网站的视觉元素(样式表、表单、模板...)
说明发生在系统各个部分的任何和所有 URL 重写操作以及它们指向的位置
使用哪个 Google Analytics/Google 网站管理员帐户以及如何获取它
理想情况下,有 API 文档和完整的 phpDoc风格源代码文档
That's kind of hard to answer without knowing what kind of portal it is, but what comes to mind:
Owner's manual: Description of functionality, technologies used, full overview of all machines and services involved (don't forget data bases)
Backup: How and where is data backed up, where to restore it from in case of a crash
Description of all Databases used, relations between tables, at least quick rundown on what data is stored where
Links to any and all URLs to administration interfaces, tools, and scripts
Day-to-day operation: What cron jobs need to run frequently, are there caches, file lists or other things that need to be taken care of frequently
Make sure all domains used belong to you and are under your control
a description of the project's file structure (which part is where; where is the API; where are the visual elements; where are the front controllers)
How-To's on how to change the visual elements of the site (Style sheets, forms, templates...)
A description of any and all URL rewriting operations that take place in various parts of the systems, and where they point to
Which Google Analytics / Google Webmaster account is used and how to get hold of it
Ideally, an API documentation and full phpDoc style source code documentation
除了 @Pekka 的好答案之外,我还会添加以下
业务需求)- 其一
解释应用程序应该如何
从商业角度工作。
架构文档)- 一个
解释了应用程序是如何进行的
从技术发展而来
看法。
指南 - 某种形式的备忘单
讲解常见问题、服务
帐户、批次计划...等
除了文档之外,您还应该了解事件趋势;
如果您没有足够的技术资源来应对每日发生的事件数量(请记住,门户使用率较高时可能存在高峰期),那么您可能会发现自己的处境与当前的服务提供商相同。
In addition to @Pekka's good answer I'd add the following
Business Requirements) - One that
explains how the application should
work from a business perspective.
Architecture document) - One that
explains how the application was
developed from a technical
perspective.
Guide - Some form of cheat sheet that
explains the common problems, service
accounts, batch schedules... etc
In addition to documentation you should be aware of the incident trends;
If you don't have enough technical resources to cover the daily number of incidents (keeping in mind there might be peak periods when usage of the portal is high) then you will probably find yourself in the same situation as your current service provider.