如何为网站制作维护文档？
如何为网站制作维护文档？
提问于 2010-04-16 00:11:48
如何制作网站维护文档？我已经创建了一个网站使用XHTML，CSS，jQuery等，这是一个大网站。
现在我必须为一个网站写一份维护文档，如果将来有任何与设计、内容和功能相关的更改，那么这些事情将由其他人处理。
我应该如何以及在维护文档中保留什么？
回答 2
Stack Overflow用户
回答已采纳
发布于 2010-04-16 00:15:16
您的维护文档应包含每个文件所包含内容的高级设计以及项目的一般代码结构。
例如，如果您编写了一些javascript来处理特定的事件，请记录这些事件以及它们如何与页面交互。
您还应该记录您所做的任何logical groupings。如果某个文件夹包含某个主题的所有XHTML，请记下这些内容。
还简要介绍了如何使用CSS对页面进行布局。哪些类在页面上的位置，以及哪些类或ids是重要的。
Stack Overflow用户
发布于 2010-04-16 00:17:23
至于如何设置，我喜欢在这种情况下设置一个维基，例如DokuWiki。它们很容易理解，而且在DokuWiki中不涉及数据库，只涉及纯文本文件。
至于是什么(除了Ben S在他的回答中很好地概述的内容)，我会涵盖
- 使用的基本技术和使用的任何客户端库及其版本
- 托管环境的目录结构概述、配置位置、控制面板URL等(从不提供联系人的实际URL和联系数据(技术支持等)外加任何使用他们的经验(如何最好地联系他们、电话、邮件等)
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/2647019
复制相关文章
相似问题
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号