如何为网站维护文档？

Question

如何为网站制作维护文件？我创建了一个使用XHTML，CSS，jQuery等的网站，它是一个大网站。

现在我必须为网站编写维护文档，以便将来如果有任何与设计，内容和功能相关的变化，那么这些事情将由其他人处理。

如何以及我应该保留在维护文档中。

Answer 1

您的维护文档应该包含一个高级设计每个文件包含什么和项目的一般代码结构。

例如，如果您编写了一些javascript来处理某些事件，请记录这些事件以及它们如何与页面交互。

您还应该记录您所做的任何逻辑分组。如果文件夹包含特定主题的所有XHTML，请将其写下。

也给一个简要说明如何使用CSS来布置页面。哪些类是页面上的哪些类，哪些类或ID很重要。

Answer 2

至于如何，我喜欢在这种情况下建立一个Wiki，例如DokuWiki。他们很容易理解，并且在DokuWiki没有涉及数据库的情况下，只是纯文本文件。

至于是什么，（除了什么奔S IN他的回答很好地概括了）我会覆盖

• 基本技术用于

• 使用的任何客户端库及其版本

• 上的目录结构

• 托管环境破旧，配置什么（技术支持等）的名称和联系人数据以及与他们有关的任何经验（如何最好地联系他们，电话，邮件等），以及控制面板URL等（从未实际的密码）