如何保存工程日志

发布于 2024-08-09 02:59:25 字数 637 浏览 1 评论 0原文

我尝试了多种方法来记录编写代码时的日常活动。它们都没有真正发挥作用。这就是我想要的:

  • 自动时间戳
  • 标记(就像我们在 stackoverflow 上所做的那样)。主要针对项目名称和使用的技术
  • 轻松根据状态会议的结果构建每周报告
  • 易于搜索以找到重复出现问题的解决方案(例如某个错误消息)
  • 可访问。可能作为网站在线,但也可能是共享文件。
  • 格式化。我希望能够轻松构建表格并分离出
    代码片段和错误报告等内容。
  • 安全。如果我可以与其他人分享该网站的一些内容,但不是全部,那就太好了。如果我得到其他东西,优先级较低。

我已经尝试了以下解决方案来解决一些问题:

  • MediaWiki:许多非常酷的功能。时间戳很难处理。奇怪的数据结构。搜索效果不佳(无法搜索三个字母或更少的单词)
  • 缺陷工具:我尝试过 mantisbt.org。安全性好。不利于格式化,而且我不喜欢他们在尝试使用该系统时的“项目”想法。
  • 纸质笔记本:非常灵活,但查找起来比较困难。不在线。

我正在考虑使用 emacs 打开远程文件以使其非常简单。有人这样试过吗?是否有另一种缺陷工具可以实现我的想法?还有其他我没有考虑过的选择吗?

I've tried several methods of keeping a log of my day-to-day activity when writing code. None of them really worked all that well. Here's what I'd like to have:

  • automatic timestamps
  • tagging (like we do on stackoverflow). Mainly for project names and technologies used
  • Easy to build a weekly report from the results for status meetings
  • Easy to search to find solutions to recurring issues (eg a certain error message)
  • Accessible. Probably online as a website, but could be a shared file.
  • Formatting. I'd like to have the ability to easily build tables and separate out <pre> content such as code snippets and error reports.
  • Security. It would be nice if I could share some content of the site with others, but not all. Low priority if I get the other stuff.

I've tried the following solutions with some issues:

  • MediaWiki: many very cool features. timestamps hard to deal with. Bizarre datastructure. Bad searching (can't search on words of three letters or less)
  • Defect tools: I tried mantisbt.org. Good security. Bad for formatting and I didn't like their idea of "projects" when trying to use the system.
  • Paper Notebook: very flexible, but hard to do the searching. Not online.

I was considering using emacs to open a remote file to keep it really simple. Has anyone tried it that way? Is there another defect tool that could do what I am thinking? Is there another option that I haven't considered?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(10

如果没有 2024-08-16 02:59:25

查看org-mode。这里有很多教程,确实有助于展示其功能/易用性。具体来说,我发现这个视频很有用。

org-mode 的主要优点(IMO)是:

  • 简单,它只是一个文本文件(或一组文件)
  • 灵活性,您可以非常简单地开始并随着您了解更多
  • 可扩展性而增加您的使用量,非常流行的新功能即将到来时间
  • 多功能性,您可以获得任务的不同视图 - 按时间、优先级、其他...排序...
  • 可读性,您可以轻松发布为 HTML 和其他形式

实际上,值得观看其中一个视频以了解可用的内容。

ORG 的作者 Carsten Dominik 用这 24 个字的引言很好地总结了这一点:

Org-mode 可以列出大纲、做笔记、
超链接、电子表格、TODO 列表、
项目规划、GTD、HTML 和 LaTeX
创作,全部使用纯文本文件
在 Emacs 中

Check out org-mode. There are a bunch of tutorials here that really help show the power/ease. Specifically, I found this video useful.

The major benefits (IMO) of org-mode are:

  • simplicity, it's just a text file (or set of files)
  • flexibility, you can start very simple and grow your usage as you learn more
  • expandability, very popular and new capabilities coming all the time
  • versatility, you can get different views of your tasks - ordered by time, priority, other...
  • readability, you can publish to HTML and other forms easily

Really, it's worth watching one of the videos to get an idea of what is available.

ORG's author, Carsten Dominik, sums it up nicely with this 24 word quote:

Org-mode does outlining, note-taking,
hyperlinks, spreadsheets, TODO lists,
project planning, GTD, HTML and LaTeX
authoring, all with plain text files
in Emacs

浅黛梨妆こ 2024-08-16 02:59:25

虽然它不具备您正在寻找的所有功能,但您可能会考虑使用老式记事本。记事本有几个宣传不佳的功能,可以方便地保存日志文件:

  1. 按 F5 插入时间戳
    随时(格式取决于什么
    您选择的日期/时间格式
    适用于您在 Windows 中的区域设置)。
  2. 如果您打开一个以
    字符串“.LOG”(不带
    引号),记事本将跳转到
    结束并插入时间戳。

我在快速启动栏添加了一个图标来打开我的日志文件,并在那里保留了各种有用的注释。该信息只是纯 ASCII,格式最少,但这意味着在需要时可以轻松将其导出到其他系统(并且很容易搜索)。

While it doesn't have all the features you're looking for, you might consider good old Notepad. Notepad has a couple of poorly advertised features that make it convenient for keeping a log file:

  1. Pressing F5 inserts a timestamp
    anytime (the format depends on what
    date/time format you have selected
    for your locale in Windows).
  2. If you open a file that begins with
    the string ".LOG" (without the
    quotes), notepad will jump to the
    end and insert a timestamp.

I added an icon to the quick launch bar to open my logfile, and I keep all sorts of useful notes there. The info is just plain ASCII with minimal formatting, but this means its easy to export it to other systems when needed (and it's easy to search).

剧终人散尽 2024-08-16 02:59:25

您可能想查看 TiddlyWiki

You might want to look at TiddlyWiki

椵侞 2024-08-16 02:59:25

我使用 Google 文档来记录我所有的个人项目以及要探索的项目想法或主题的列表。它可搜索,可复制/粘贴以进行共享,如果需要,我可以共享整个文档,最重要的是它随处可用。

I use Google documents to keep notes for all of my personal projects as well as a list of project ideas or topics to explore. Its searchable, is copy/pastable for sharing and I could share entire documents if needed, and best of all its available everywhere.

哭泣的笑容 2024-08-16 02:59:25

对于个人来说这可能有点过分了,但我们(大约 10 个人)需要一个活动日志,最终使用了 Trac 取得了很好的成果。

  • 自动时间戳

任何操作都会获得自动时间戳。

  • 标记(就像我们在 stackoverflow 上所做的那样)。主要是项目名称和使用的技术

TagsPlugin

  • 轻松根据状态会议的结果构建每周报告

您可以从 时间线。如果您将任务组织为工单,您还可以定义自己的报告自定义查询

  • 易于搜索以找到重复出现的问题(例如某个错误消息)的解决方案

搜索

  • 无障碍。可能作为网站在线,但也可能是共享文件。

Trac 使用简约的方法进行基于 Web 的软件项目管理。

  • 格式化。我希望能够轻松构建表格并分离出
    代码片段和错误报告等内容。

Trac 允许在描述中使用 wiki 标记

  • 安全。如果我可以与其他人分享该网站的一些内容,但不是全部,那就太好了。如果我得到其他东西,优先级较低。

Trac 使用简单、区分大小写的权限系统来控制用户可以执行的操作以及无法访问。从 0.11 开始,有一个通用机制允许自定义权限策略插件授予或拒绝任何对任何类型的 Trac 资源执行操作,甚至是在此类资源的特定版本级别。

It may be an overkill for an individual, but we (approx. 10 people) needed an activity log and ended up using Trac with great results.

  • automatic timestamps

Any operation gets an automatic timestamp.

  • tagging (like we do on stackoverflow). Mainly for project names and technologies used

TagsPlugin

  • Easy to build a weekly report from the results for status meetings

You can get an overview from Timeline. If you organize your tasks as tickets, you may also define your own reports and custom queries.

  • Easy to search to find solutions to recurring issues (eg a certain error message)

Search

  • Accessible. Probably online as a website, but could be a shared file.

Trac uses a minimalistic approach to web-based software project management.

  • Formatting. I'd like to have the ability to easily build tables and separate out <pre> content such as code snippets and error reports.

Trac allows wiki markup in descriptions.

  • Security. It would be nice if I could share some content of the site with others, but not all. Low priority if I get the other stuff.

Trac uses a simple, case sensitive, permission system to control what users can and can't access. Since 0.11, there's a general mechanism in place that allows custom permission policy plugins to grant or deny any action on any kind of Trac resources, even at the level of specific versions of such resources.

拥有 2024-08-16 02:59:25

查看 Emacs 变更日志。

标记

Check out Emacs ChangeLogs.

Mark

森罗 2024-08-16 02:59:25

私人推特帐户怎么样?

How about a private twitter account?

最好是你 2024-08-16 02:59:25

如果您的工作流程非常基于电子邮件,那么诸如 posterous 之类的内容可能会很有用,因为您可以发送电子邮件并通过在电子邮件主题中添加标签进行分类。大多数应用程序都集成了电子邮件,因此这是“即时”收集和组织信息的不错选择

If your work flow is very e-mail based then something like posterous might be useful as you can fire off e-mail and categorize by adding tags in the subject of the e-mail. Most apps have e-mail integration so this is a good option for collecting and organizing information "on the run"

纸短情长 2024-08-16 02:59:25

您看过 VersionOne 吗?他们有免费的“团队”版本的软件。它是围绕敏捷软件方法构建的,因此要使用它来跟踪您的工程日志,您必须构建积压工作,然后根据这些积压项目记录您的工作。话虽如此,它有很多你想要的东西。它会跟踪您消耗工作的速度,这将有助于形成良好的每周报告。它还将具有您正在寻找的搜索和可访问性。我认为它不会有的唯一一件事是格式。我们使用企业版,所以我不太熟悉免费的“团队”版本,但它可能值得研究。

Have you ever looked at VersionOne? They have a free "Team" version of the software. It's built around the Agile Software methodology, so to use it to track your engineering log, you'd have to build a backlog of work and then record your work against those backlog items. That all being said, it has a lot of what your looking for. It tracks the rate at which you're burning down your work, which would make for good weekly reports. It would also have the search and accessibility you're looking for. The only thing I don't think it would have would be the formatting. We use the Enterprise Edition, so I'm not as familiar with the free "Team" version, but it might be worth looking into.

愁以何悠 2024-08-16 02:59:25

如果是关于编写代码,则使用版本控制系统的提交消息。如果正确使用它,您会在任务完成时(而不是在启动任务时)获得带有时间戳的准确日志

  • 自动时间戳 [检查]
  • 标记 [检查,使用提交消息]
  • 轻松构建每周报告 [检查,更改日志脚本]
  • 易于搜索[hmmmm]
  • 可访问。 [检查]
  • 格式化。 [可能不是]
  • 安全。 [检查,项目基地]

If it is about writing code, then use the version control system's commit messages. If you use it correctly you get an exact log with timestamps when tasks have been finished (not when you started a task)

  • automatic timestamps [CHECK]
  • tagging [CHECK, use commit message]
  • Easy to build a weekly report [CHECK, changelog scripts]
  • Easy to search [hmmmm]
  • Accessible. [CHECK]
  • Formatting. [PROBABLY NOT]
  • Security. [CHECK, project base]
~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文