如何为网站制作维护文件?

时间:2010-04-15 16:11:48

标签: css xhtml documentation web-site-project

如何为网站制作维护文件?我使用XHTML,CSS,jQuery等创建了一个网站,这是一个很棒的网站。

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

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

2 个答案:

答案 0 :(得分:3)

您的维护文档应包含每个文件包含的高级设计以及项目的常规代码结构。

例如,如果您编写了一些 javascript来处理某些事件,请记录这些事件及其与网页的互动方式。

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

还提供简要说明您如何使用CSS来布局页面。哪些类在页面上的位置,以及哪些类或ID很重要。

答案 1 :(得分:1)

至于如何,我喜欢在这种情况下设置Wiki,例如DokuWiki。它们很容易理解,如果是DokuWiki,则不涉及数据库,只有纯文本文件。

关于什么,(除了Ben S在他的回答中简要概述的内容)我将覆盖

  • 使用的基本技术

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

  • 目录结构的纲要

  • 托管环境,配置位置,控制面板网址等(从不实际密码)

  • 联系人的姓名和联系方式(技术支持等)以及与他们的任何经验(如何最好地联系他们,电话,邮件等)