记录Web项目的技术

构建多个网站的一个好处是，最终，你会多次面临相同的挑战。这意味着你将确切地知道该做什么。也就是说，如果你记得以前在哪里和什么时候见过这个问题。

有多少次你需要完成一件事，并意识到，是的，你已经写了一段代码，这将是一个完美的适合？那么，同一个片段几乎不可能找到的频率是多少？

毫无疑问，这是网页设计师的一个常见禁忌。这就是为什么写一些基本的项目文档可以证明是有益的。通过建立这样一个系统，您将有一个简单的方法找到节省时间的代码片段。

无论你是在做一个新项目，还是在回顾过去的一些项目，这里都有一些记录你所做事情的技巧。

注释您的代码

这一点似乎有点明显，但同样重要。在编写代码时，添加适当的注释来说明它的具体功能是有意义的。

常见做法包括在每个新功能上方写一个简短的叙述，例如，解释其目的和与项目的相关性。除此之外，在这些函数中的其他关键位置添加注释可以让我们（以及其他审阅代码的人）更好地理解所有内容是如何组合在一起的。

这种做法不仅仅适用于像PHP或JavaScript这样的复杂语言。它也是CSS的完美选择。指出具体的风格以及它们在哪里被使用，这对于准确地找到您需要的东西非常有用。

通常感觉战斗的一半只是记住为什么每条线都在那里以及它应该做什么。评论可以消除很多歧义。

为每个项目创建日记账

现在，根据你的个性，提到“日记”这个词可能会非常可怕，也可能会让人感到奇怪的安慰。你的反应可能会告诉你如何处理这类任务。

在本例中，我们讨论的是作为未来资源的文档。如果网站崩溃或需要一个新的功能，这将是一个地方，你可以参考的细节是如何做的事情。打开文字处理文档或全力以赴在本地安装上创建Wiki。它可以像你喜欢的那样详细（或不详细）。这里没有硬性规定。

例如，我们的设计和开发技术往往会随着时间的推移而演变。你几年前采取的方法可能与你今天所做的不同。因此，重要的是将过程中的各种要素融入到写作中。

此外，即使在使用通用系统和库时，每个网站都是自己独立的实体。不知道从哪里开始？看看是什么让这个网站脱颖而出。记下您创建的特殊模板、特定代码段或样式。如果你不得不对你的服务器做一些不同的事情，那么记录下来也是一件很棒的事情。

维护代码段库

当涉及到代码时，不要试图重新发明轮子。我们写的很多东西都是无限可重用的。即使它不完全符合新项目的需要，正确的代码片段也可以作为进一步定制的坚实起点。

然而，组织不同的代码位可能是一个挑战。您可以将有用的部分复制并粘贴到文档中，然后根据需要检索它们。但对于那些编写大量代码的人来说，这可能很快就会失控。

GitHub存储库将是一个很好的解决方案。它将允许您对事物进行分类，并允许进行版本控制。您甚至可以将存储库与另一个服务绑定在一起，以便以不同的方式使用或访问它。

无论您如何将代码段库放在一起，您都需要开发某种系统来标记、分类或以其他方式标记每个代码段。例如，您可能需要添加一些内容，如所使用的编码语言、目的、相关应用程序（如WordPress）或库（React、Vue、Bootstrap）。这将使搜索和查找您需要的内容的过程更加顺利。

你作品的百科全书

网页设计师喜欢制作作品集来展示他们的作品，或者至少是最终的结果。但在内部跟踪项目也是一项值得努力的工作。它可以帮助您排除故障并在现有网站上构建，同时为新网站提供解决方案。

您可以使用上述任何或所有技术来组织事情。最好的部分是，你真的可以自定义它的方式，你觉得合适。无论是通过如饥似渴的记笔记还是简单的提醒，它都将帮助你更好地了解你的web项目的内容、地点、时间和原因。

来源：https://speckyboy.com/techniques-documenting-web-projects/