准备小型网站时,追踪每个页面及其地址很容易变得混乱。一份简短的清单记录每个页面的名称、完整地址和用途备注,无论你是独自工作还是把项目交给别人,都能帮助你保持条理。本文通过一个明确的假设示例来演示如何建立这样的清单。

用一个假设项目来练习

假设你正在规划一个摄影爱好小型网站。网站计划有四个页面:首页、画廊页、关于页和联系页。你还没有开始搭建任何东西,也没有域名。你现在只想写一份清单,这样将来真正搭建网站时,或者向帮忙的朋友描述时,大家都能指向相同的页面而不产生混淆。这是一个纯粹的假设场景,用来说明记录过程;这些页面都不存在于互联网上。

清单从三列开始:你自己选定的简短页面名称、该页面将来会使用的完整地址,以及一条说明页面用途或链接关系的备注。即使还没有任何页面发布,填写第一列和第三列就能给你一个可用的大纲。第二列可以暂时用占位符,等你确定实际域名后再替换,但现在写下预期的路径结构有助于你思考页面之间的关系。

在这个例子中,四行内容大致如下。页面名称:首页。预期路径:/index.html。备注:着陆页,链接到画廊和关于页。页面名称:画廊。预期路径:/gallery.html。备注:展示照片缩略图,链接回首页。页面名称:关于。预期路径:/about.html。备注:简短自我介绍,链接到联系页。页面名称:联系。预期路径:/contact.html。备注:邮箱地址和社交链接,链接回首页。这张简单的表格已经告诉你有多少个页面、每个页面的用途,以及哪些页面链接到哪些页面。

为什么要把页面名和地址分开记录

页面名称是你为自己的参考而创造的标签。它不必与文件名或URL路径完全一致。例如,你可能在笔记中把一个页面称为「画廊」,即使文件名是gallery.html或路径是/photos/gallery。把人类友好的名称放在单独一列,意味着即使技术细节后来改变,你的清单仍然可读。相比之下,域名是标识互联网上某台网络服务器的人类可读地址,如MDN域名文档所述。1

把名称和地址并排记录可以防止一个常见的混淆来源:两个人用不同的标签指代同一个页面。如果一个人说「照片页」而另一个人说「画廊」,清单就能消除歧义,因为两个条目都指向同一行。当项目涉及多个贡献者,或者你隔了一段时间回来需要快速重新定位时,这一点特别有用。

用你口头描述网站时会使用的形式来写页面名称。避免只有当下才有意义的缩写或内部代号。如果后来重命名了某个页面,立即更新清单,使名称列始终反映你当前的用语习惯。这个做法在初始规划阶段几乎不花成本,但在将来任何交接或复查时能节省大量时间。

记录完整地址及其各部分

URL是互联网上唯一资源的地址,由不同部分组成,有些是必需的,有些是可选的。根据MDN的URL文档,最重要的部分包括方案(如https)、权限部分(包含域名)、资源路径、由问号引导的可选参数,以及由井号引导的可选锚点。当你在清单中记录完整地址时,你是在一个字符串中捕获所有这些部分。2

在早期规划阶段你可能还不知道域名,所以URL的权限部分会是占位符。这没关系。这个阶段重要的是准确记录路径部分,因为路径决定了资源相对于网站根目录的位置。MDN指出,在早期网络时代路径代表服务器上的物理文件位置,但现在它主要是由网络服务器处理的抽象概念,没有物理实体。对你的清单来说,路径仍然是区分不同页面的最有用方式。2

记录完整预期地址时使用统一格式。如果你的假设域名是example.org,画廊页的地址就是https://example.org/gallery.html。明确写出方案和域名,即使它们是占位符,也能训练你思考完整地址而非仅仅文件名。这减少了以后需要与他人分享地址或将其粘贴到HTML的链接元素中时出错的可能。2

添加关于链接和用途的备注

备注列是你记录页面间关系的地方。MDN的超链接文档解释说,属于同一网站的两个网页之间的链接称为内部链接,没有内部链接就不存在所谓的网站。当你记录哪些页面链接到哪些页面时,你实际上是在编写任何代码之前勾画网站的内部链接结构。3

为清单中的每一行写一到两句话,描述页面用途并列出它应该链接到的页面。对于假设示例中的画廊页,备注可以写成:以网格形式展示照片缩略图;链接回首页,如果以后添加单独照片页则链接过去。这个详细程度足以完成交接,又不会过度指定尚未做出的实现选择。

检查清单中每个页面至少被另一个页面链接到。MDN关于超链接的建议指出,每当你添加一个新网页时,至少应有一个其他页面链接到该新页面。如果你的清单显示某个页面没有记录任何入站链接,这是一个信号,提示你要么从另一个页面添加链接,要么重新考虑该页面是否属于这个网站。这个简单的审查步骤能在孤立页面成为问题之前发现它们。3

核对清单条目

在认为清单完成之前,记录一次核验过程。逐行检查并确认三件事:页面名称唯一且无歧义,路径不与其他行重复,备注至少提到一个链接关系。如果任何一行未通过其中一项检查,在继续之前修改它。对于四页网站来说这次核验只需几分钟,但能养成一个可以扩展到更大项目的习惯。

在所有行中使用一致的路径格式。决定是否包含前导斜杠、是否显示文件扩展名、目录风格的路径是否以尾部斜杠结尾。在同一份清单中混用格式会产生视觉噪音,使重复项更难被发现。对于假设的摄影网站,选择/gallery.html而非gallery.html或/gallery/能让每个条目在视觉上保持平行。

如果你是为别人准备这份清单,大声朗读或请朋友在没有你解释的情况下阅读它。如果他们仅凭清单就能识别每个页面的用途及其与其他页面的连接,文档就可以交接了。如果他们提出澄清问题,这些问题就暴露了你应该在备注列中填补的空白。这种低成本的复查能在开发过程中大多数误解变成实际问题之前将其捕获。

让清单持续有用

清单的价值取决于它当前的准确性。当你在开发过程中添加、删除或重命名页面时,立即更新对应的行。把清单当作与项目文件并存的活文档,而非写完就忘的一次性产物。即使是短暂的更新延迟,也可能在另一个人阅读过期版本时造成混淆。

把清单存放在容易找到且容易编辑的位置。纯文本文件、简单的电子表格或项目维基中的页面都可以。格式不如保持更新的习惯重要。如果你后来决定在真实域名下发布网站,把每个URL中的占位权限部分替换为实际域名,并验证每个完整地址的格式正确。

当项目完成或交给另一个人时,清单成为一份参考文档,无需任何人翻阅源代码就能回答基本问题。它告诉新贡献者有多少个页面、每个页面做什么、它们如何连接。对于首次建站者来说,这一小步组织工作在你每次需要解释项目、排查断链或规划一个融入现有结构的新页面时都会带来回报。

常见问题

在制作这份清单之前我需要拥有域名吗?

不需要。你可以在规划阶段在地址列中使用占位域名。规划阶段重要的是路径和关于每个页面用途及链接的备注。你以后用真实域名替换占位符即可。

备注列应该写多详细?

每个页面一到两句话通常就够了。说明页面用途并列出它链接到哪些其他页面。你不需要在这个阶段描述布局、颜色或技术实现。

如果清单已经写好后我又添加了一个页面怎么办?

立即添加新行,并检查至少有一个现有页面链接到新页面。同时验证路径不与已有条目重复。保持清单的时效性比保持简短更重要。3