Web开发:如何编写网站规范文档?

时间:2011-03-08 18:56:12

标签: documentation specifications

我正在为我的网站编写规范文档(这是一个学校项目,顺便说一句)。我目前对网站的整体布局和主题,您如何浏览网站以及内容的简要描述有所了解。但是我没有所有页面的列表;我应该加入吗?

另外,如何确定我网站的技术规格?我知道,例如,我需要PHP 5(或兼容),但我不确定要求什么版本的HTML,CSS和JavaScript。我如何确定这些要求?

3 个答案:

答案 0 :(得分:0)

HTML版本可以在第一个DOCTYPE标记中找到,通常在第一行:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

在这种情况下,它是XHTML 1.0 Transitional。 至于CSS,大多数浏览器都使用版本2,但除非你使用一些疯狂的新CSS功能,否则它将是微不足道的。对于javascript,根据维基百科页面,最新版本是1.8.2。这再次并不重要,Javascript版本之间的差异通常非常小。

答案 1 :(得分:0)

我认为每个页面的列表都会包含在文档的“导航”部分中。另外,为了确定您的HTML,CSS和Javascript版本,我建议使用“在所有主流浏览器中使用符合标准的HTML,CSS和Javascript”。或类似的东西。你不一定需要自己使用特定的格式,只要它在你想要的浏览器中做你想要的。我认为一个好的需求doc会避免为开发人员做出这样的决定并坚持使用决定诸如内容的样子,导航地图是什么,提供什么内容以及功能。

作为HTML标准的示例,如果您希望页面为"validate" as a particular HTML standard,那么您可能希望在标题中指明该版本,但标题本身对于浏览器是不必要的,除非告诉它以标准或怪癖模式呈现。对于“标准”模式站点,使用HTML 5文档类型is all that you need

答案 2 :(得分:0)

编写技术规范。

回答以下问题。

1)您的网站是什么?它有什么用途?

2)该网站的用户是谁,他们是否购买了问题1的答案?

3)来自问题2的观众......他们将从哪种类型的计算机/设备访问该网站?

通过回答这些问题,您将了解必须设计的最低要求。例如,如果您销售的每个人都使用古老的硬件(使用直接HTML开发没有javascript,使用表格进行布局);)如果您的目标是年轻的,精通计算机的用户,请使用HTML5,CSS3,jQuery进行开发。 / p>

除非您尝试大规模创建网站,否则服务器端技术没有什么区别。 (支持数百万用户)

我会包含一个站点地图(页面列表)