跟踪/记录您当前正在进行的编程项目的最佳方式是什么

Question

我已经被这个问题困扰很长时间了，我想知道它在真实/大公司项目中是如何完成的。

假设我有一个建立网站的项目。现在我将项目分成子任务并执行。

但是你知道，假设我手里有

task1

，就像导出

page to pdf

一样。现在我花了三天时间来做这件事，遇到了各种问题，很多堆栈溢出问题，最后我解决了。

现在 4 个月后，有人告诉我代码中有一些错误。

现在我完全忘记了（60％）我是如何做到的以及为什么我这样做。我记录了代码，但我无法在代码中写下整个故事。

然后我必须花很多时间在代码上找到问题所在，所以我添加了这一行等等。

我想知道有什么方法可以记录完成项目的步骤。 这样我就可以看到我如何最终得到代码，我遇到了什么错误，我在 So 上问了哪些问题等等。

人们如何实时做到这一点。使用什么软件。

我知道在我们名为

JIRA

的项目管理软件中，我们有任务，但这并不涵盖 我采取了哪些步骤来解决该任务。

什么是最好的方法，这样当我回顾我两年前的项目时，我知道如何解决特定任务

Answer 1

如果您已经在使用 JIRA，请考虑将其与您的 SCM 集成。

将更改提交到 SCM 时，请参阅注释中的 JIRA 问题编号。就像下面这样：

PORTAL-778 fixed the alignment issue with PDF exports

JIRA 定期连接到您的 SCM 并解析评论。您可以轻松找到针对特定问题所做的更改。

请参阅以下链接了解更多信息

将 JIRA 与 Subversion 集成

Answer 2

每次重新访问代码时，列出您没有找到的信息。然后，下次创建代码时，请确保该信息存在。它可以是评论、Wiki、错误，甚至是单独文件中的文本注释。让笔记对其他人有用，因此除了个人笔记之外，私人笔记本并不是一个好主意。

Answer 3

我做了两件事。

1. 我尝试忽略“评论羞辱”，并在需要时仍然写长评论。由于大多数 IDE 都会折叠多行注释，我的同事并不反对。更不用说我们正在开发一个庞大的项目，而且文档（Wiki、Cinfluence）通常相当缺乏......

2. 我确实保留了个人知识库/维基。它基本上是几个超长的概念页面，每个新项目都有一个标题 1。我在它创建的页面顶部放置了一个目录块 标题链接列表 - 方便导航。 这个个人维基给我带来了奇迹。一旦我发现一些我不知道该怎么做并且我怀疑明年我会再次需要它的东西，我就把它放在我的维基中。两个（典型）例子 2.1 我的公司让我在 Linux 桌面上工作（我不喜欢它，但没有时间安装 Windows 并进行设置）。所以我有大约 20 篇关于如何在 Linux 上做奇怪的事情的迷你 wiki 文章，我总是忘记怎么做。 “创建键盘快捷键以删除 shell 中的日志文件”或“修复 Slack 不与 Wayland Ubuntu 共享屏幕”等。 2.2 我在工作上花费时间和精力的事情，比如学习。关于一个新的（对我来说）功能是如何工作的。我不得不询问同事，自己思考，破解整个游乐园等。我有这样的指南...花了一周的时间进行研究，相当于 4-10 张 a4 页。

您还可以写日记。我对此不太一致，但如果您知道船长日志是什么，您可以在文本/wiki 文件中模拟它，然后只需按 jira 任务编号或某些关键字按 ctrl+f 即可。

希望这有帮助！