task-logbook

Maintains append-only Markdown logbooks and coordinating GitHub issues for reproducible experiments.

3.2k|266|Updated Mar 22, 2024
One-click install
npx skills add https://github.com/marin-community/marin --skill task-logbook
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: task-logbook
Source: https://github.com/marin-community/marin/tree/main/.agents/skills/task-logbook
Command: npx skills add https://github.com/marin-community/marin --skill task-logbook

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Long-running research and engineering tasks lose context across sessions: experiment commands, results, failures, and decisions get scattered or forgotten. This Skill provides a durable, append-only logbook format plus rules for keeping a coordinating GitHub issue in sync, so work remains reproducible and auditable.

Core Features & Use Cases

  • Structured Logbook Template: Creates Markdown logbooks under .agents/logbooks/<topic>.md with YAML frontmatter, scope, baseline, and timestamped entry logs recording hypothesis, commit hash, command, config, result, and next action.
  • Living Indices: Maintains editable summary sections (TL;DR, hypothesis queue, decision log, negative results index) with traceable links to entries, commits, and W&B runs.
  • Coordinating Issue Workflow: Defines promotion rules for posting milestone updates as GitHub issue comments, maintaining the issue body as the current summary, and closing with a final agreed conclusion.
  • Use Case: While running a multi-day model training experiment, log each run's command, hash, and metrics in the logbook, post milestone updates to the tracking issue, and close it with a final summary of what worked and what did not.

Quick Start

Create a task logbook for my current experiment and record the baseline results with the exact command and commit hash.

Frequently Asked Questions about task-logbook

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep a reproducible experiment log across sessions?

Create a Markdown logbook under .agents/logbooks/<topic>.md with YAML frontmatter, then append timestamped entries recording the hypothesis, commit hash, exact command, config, result, and next action. Entries are append-only so history is never rewritten.

How do I track experiments with a GitHub issue?

Link the coordinating issue near the top of the logbook, post milestone updates as issue comments using the update template, and maintain the issue body as the current summary with TL;DR, decisions, and negative results. Close the issue once the final logbook entry and summary agree.

When should I use a task logbook?

Use it only when explicitly requested for durable cross-session notes, reproducible experiments, or work coordinated through a GitHub issue. It is not intended for trivial one-off tasks that do not need an audit trail.

Can I edit or delete old logbook entries?

No, the entry log is append-only. You may only fix formatting, broken links, or add a coordinating issue reference. Revised or falsified hypotheses stay in the log; update the hypothesis queue status and link to the evidence instead.

How often should I post updates to the coordinating issue?

Post an update at each significant milestone or every 6 hours of active work, whichever comes first. If no milestone occurred by the deadline, post a brief heartbeat with current status, blockers, and next ETA.