門戶維護文檔

Question

我們外包了一個基於Web的門戶，現在我們不想與他們合作，因爲該網站日益變得越來越多，客戶的投訴也越來越多。

我們根據當地的聲譽選擇了不同的團隊，他們的投資組合很好地滿足了我們的迫切需求。我們與他們討論了這個項目，並在一週內提出了一些有助於我們控制的好主意。我們同意將這個項目授予他們。我在轉換過程中的想法：

您認爲哪些文件可以幫助新開發人員理解應用程序？我可以向他們要求多少種文件？如果新開發人員開始着手開發這些文檔，這些文檔將幫助他們輕鬆理解各方面（應用程序，數據庫，配置等）

該應用程序位於ASP.NET和SQL SERVER 2005上，是所有無源控件中最可怕的部分工具在那裏。他們直接部署，甚至無需推送發佈按鈕。觸摸運氣:(

感謝

Answer 1

這是一種很難不知道它是什麼樣的門戶網站來回答，但想到什麼：

• 用戶手冊：功能說明，技術（不要忘記數據庫）

• 備份：數據備份的方式和位置，在發生崩潰時從何處恢復數據

• 所有數據庫的說明使用，表之間的關係，至少簡要總結上存儲什麼數據，其中

• 鏈接到任何和所有的URL到管理界面，工具和腳本

• 日至天的操作：工作需要什麼樣的cron頻繁運行，是否有緩存，文件列表或需要採取的頻繁

• 護理確保使用的各種域名屬於自己的，是你的控制

下其他東西

• 描述項目的文件結構（哪一部分是哪裏; API在哪裏？視覺元素在哪裏？哪裏是前端控制器）

• 如何改變網站的視覺元素（樣式表，表格，模板...）

• 的任何說明和所有URL重寫是發生在系統的各個部分，並在它們指向

• 具體使用哪谷歌分析/谷歌網站管理員帳戶，以及如何獲得的握住操作它

• 理想情況下，API文檔和完整PHPDoc的風格源代碼文檔

Answer 2

除了@佩卡的很好的答案我會添加以下

• 功能設計文檔（或 業務需求） - 一個 解釋如何應用應該從商業角度 工作。
• 技術規範（或 體系結構文檔） - 一個 解釋如何從技術 角度開發的應用程序是 。
• 應用支持 指南 - 小抄的某種形式的 解釋了常見問題，服務 帳戶，批處理調度...等

除了文檔，你應該知道的事件趨勢;

• 可能發生什麼事件？
• 多久？
• 他們需要多長時間才能解決？
• 有多少已知缺陷？
• 誰在維護基礎設施（修補操作系統，安全審計等）

如果你沒有足夠的技術資源，以支付日常號事件（記住的有可能是高峯期時使用的門戶很高），那麼您可能會發現自己與當前的服務提供商處於相同的情況。